Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #11

Closed
liamsi opened this issue Jan 11, 2021 · 0 comments · Fixed by #56
Closed

Improve documentation #11

liamsi opened this issue Jan 11, 2021 · 0 comments · Fixed by #56
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@liamsi
Copy link
Member

liamsi commented Jan 11, 2021

Currently, some of the exported methods/structs are not properly documented.

Ideally, the readme would contain slightly more information about the repository and how it's meant to be used. The SMT repo's readme is a good example. A runnable example test would also be useful.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation celestiaorg/rsmt2d
1 participant
@liamsi