docs: fix disk buffer comment wording#4817
Open
Rohan5commit wants to merge 1 commit intorust-lang:mainfrom
Open
docs: fix disk buffer comment wording#4817Rohan5commit wants to merge 1 commit intorust-lang:mainfrom
Rohan5commit wants to merge 1 commit intorust-lang:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates a doc comment in the disk I/O buffer implementation to improve wording/clarity without changing runtime behavior.
Changes:
- Adjusted wording in the
FileBuffer::cleardoc comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| impl FileBuffer { | ||
| /// All the buffers space to be re-used when the last reference to it is dropped. | ||
| /// All the buffer space to be reused when the last reference to it is dropped. |
There was a problem hiding this comment.
This doc comment is still an incomplete sentence (“All the buffer space …”). Consider rephrasing to a verb-led sentence (e.g., starting with “Allows …”/“Allow …” or “Releases …”) so it reads clearly in rustdoc and accurately describes what clear() does.
Suggested change
| /// All the buffer space to be reused when the last reference to it is dropped. | |
| /// Releases the buffer space to be reused when the last reference to it is dropped. |
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
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
Related issue
Guideline alignment
README.mdValidation
git diff --check