Added doc-comments to Nox #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akhilles
reviewed
May 2, 2024
|
Thank you! I have just fixed the comments following your feedback. |
akhilles
reviewed
May 16, 2024
|
Thank you! I included your comment in the latest commit. |
akhilles
approved these changes
May 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the discussion in issue 11 and the preliminary test in PR 12, here is a PR adding doc comments to the entire Nox codebase. As previously stated, the comments are AI-generated, with the goal of speeding up the documentation of the library (it is easier to improve a bad comment than to write one from scratch).
The PR is best examined by generating the documentation (
cargo doc --open --no-deps --all-features).Do not hesitate to comment and criticize; some comments will definitely require manual improvements.
One thing that is still missing, and should probably be done by hand, is a
lib.rstop comment that serves as a documentation readme (ideally with a small code example1 showcasing usage and/or a link to the relevant section of the Elodin doc). You can find an example of one such comment here (rendered there).Footnotes
Overall, code examples are the big thing still missing from a new user's perspective. ↩