-
Notifications
You must be signed in to change notification settings - Fork 119
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
Add documentation #22
Comments
Do you consider the recent update to README.md sufficient? |
I think we need to move the README docs into doc comments |
I think adding the doc comments would be useful, but not as a replacement for the README. The doc comments are great for explaining a thing once you're looking at it, but the README gives the overview of what to look at. That said, I think the README could still be a good deal better organized. We could potentially remove most of the function signatures from the README and replace them with links to rust-doc. Then the README would just serve as a quick reference for what types of noise functions are available. |
Yeah, I think the README might be better if it had a high level overview with a simple example. |
*delete |
There is little documentation in the library...
The text was updated successfully, but these errors were encountered: