docs: rewrite comments documentation#9591
Merged
orizi merged 1 commit intostarkware-libs:mainfrom Feb 3, 2026
Merged
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
|
This change is |
orizi
approved these changes
Feb 3, 2026
Collaborator
orizi
left a comment
There was a problem hiding this comment.
@orizi reviewed 1 file and all commit messages, and made 1 comment.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @Evelina331).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Rewrote the comments documentation to include doc comments (
///) and module-level comments (//!), providing a complete overview of commenting styles.Type of change
Please check one:
Why is this change needed?
The previous documentation only mentioned line comments (
//) and ignored documentation comments, which are essential for documenting APIs.What was the behavior or documentation before?
The file contained a single sentence about line comments.
What is the behavior or documentation after?
The file now details all three comment types with examples showing how to use them for code explanation and documentation generation.
Related issue or discussion (if any)
Additional context