semaphore-protocol / semaphore

A zero-knowledge protocol for anonymous interactions.

https://semaphore.pse.dev

MIT License

887 stars 194 forks source link

More documentation on group lib code #665

Closed cedoor closed 6 months ago

cedoor commented 6 months ago

Description

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

Related Issue(s)

483

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] 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