rust: use doc comments #1668
Merged
rust: use doc comments #1668
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
Rust distinguishes between doc and non-doc comments. Using doc comments avoids the compiler to warn about undocumented code. Extracted rust files are updated.
armfazh
force-pushed
the
rust_docstring
branch
from
6e4a22f
to
504c3ef
Compare
4 tasks
JasonGross
approved these changes
Oct 1, 2023
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.
Rust distinguishes between doc and non-doc comments. See https://doc.rust-lang.org/stable/reference/comments.html
Using doc comments avoids the compiler to warn about undocumented code.