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.

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

Closed
bvssvni opened this issue Aug 30, 2014 · 5 comments
Closed

Add documentation #22

bvssvni opened this issue Aug 30, 2014 · 5 comments

Comments

@bvssvni
Copy link
Contributor

bvssvni commented Aug 30, 2014

There is little documentation in the library...

@Cifram
Copy link
Collaborator

Cifram commented Jan 15, 2015

Do you consider the recent update to README.md sufficient?

@brendanzab
Copy link
Collaborator

I think we need to move the README docs into doc comments

@Cifram
Copy link
Collaborator

Cifram commented Jan 16, 2015

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.

@brendanzab
Copy link
Collaborator

Yeah, I think the README might be better if it had a high level overview with a simple example.

@David-OConnor
Copy link

David-OConnor commented Jul 16, 2018

*delete

@Razaekel Razaekel closed this as not planned Won't fix, can't repro, duplicate, stale May 19, 2024
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

No branches or pull requests

5 participants