Skip to content

More documentation on proof lib code #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 28, 2024
Merged

More documentation on proof lib code #664

merged 3 commits into from
Feb 28, 2024

Conversation

cedoor
Copy link
Member

@cedoor cedoor commented Feb 28, 2024

Description

This PR adds more documentation to the proof package functions and updates the TypeDoc link.

Related Issue(s)

#483

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have run yarn prettier and yarn lint without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

The commit adds more documentation to the proof package functions and updates the TypeDoc link.

re #483
@cedoor cedoor requested a review from vplasencia February 28, 2024 12:25
Copy link
Member

@vplasencia vplasencia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great ✨

Added some comments.

Copy link
Contributor

@0xjei 0xjei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely work. Reading some new comments on top of the functions is literally a pleasure.

@cedoor cedoor merged commit 2c144fc into feat/semaphore-v4 Feb 28, 2024
@cedoor cedoor deleted the docs/proof branch February 28, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants