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

Better documentation #13

Open
finnkauski opened this issue Jul 12, 2020 · 0 comments
Open

Better documentation #13

finnkauski opened this issue Jul 12, 2020 · 0 comments
Assignees
@finnkauski
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@finnkauski
Copy link
Owner

Is your feature request related to a problem? Please describe.
The crate needs better documentation. Things like the top level of the crate are not documented. It also needs some doctest type stuff in the examples as part of the documentation.
@finnkauski finnkauski added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jul 12, 2020
@finnkauski finnkauski self-assigned this Jul 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@finnkauski finnkauski

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@finnkauski