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

Expanded docs for simple_rng #22

Open
joshfactorial opened this issue Nov 20, 2024 · 0 comments
Open

Expanded docs for simple_rng #22

joshfactorial opened this issue Nov 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@joshfactorial
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
I haven't fully explored the documentation side of Rust, so some of that is lacking throughout, other than line comments. Expanding the documentation of this section might provide a solid template for the rest.

Describe the solution you'd like
Starting with what they have in the Rust book: https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html?highlight=Documentation#making-useful-documentation-comments

  • Review rust docs for Documentation recommended practices
  • Review existing comments in simple_rng/src/lib.rs
  • Update, request clarification, expand as needed
@joshfactorial joshfactorial added the documentation Improvements or additions to documentation label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant