While I was looking at the new code I discovered that some parts of the code weren't documented yet. This PR does at least add some basic documentation to all parts of the code.
I've changed the style of documentation a bit to use the style recommended in the Rust style guide and API guidelines. While the preferred commenting style is subjective there are some objective advantages of using the recommended style. Especially using a summary line (https://doc.rust-lang.org/1.0.0/style/style/comments.html#summary-line) makes the generated docs more readable.
almindor
commented
1 year ago
While I was looking at the new code I discovered that some parts of the code weren't documented yet. This PR does at least add some basic documentation to all parts of the code.
I've changed the style of documentation a bit to use the style recommended in the Rust style guide and API guidelines. While the preferred commenting style is subjective there are some objective advantages of using the recommended style. Especially using a summary line (https://doc.rust-lang.org/1.0.0/style/style/comments.html#summary-line) makes the generated docs more readable.