ncsa / rusty-neat

This is a Rust implementation of the next-gen sequencing toolkit (NEAT).
Other
0 stars 0 forks source link

Expanded docs for simple_rng #22

Open joshfactorial opened 1 week ago

joshfactorial commented 1 week ago

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