docs: fix diskio comment wording#4829
Open
Rohan5commit wants to merge 1 commit intorust-lang:mainfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates a Rust doc comment in diskio to improve wording, without changing runtime behavior.
Changes:
- Adjusted the hyphenation of “re-used” → “reused” in a
FileBuffermethod 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 buffers space to be reused when the last reference to it is dropped. |
There was a problem hiding this comment.
The doc comment reads a bit ungrammatically (“All the buffers space…”). Consider rephrasing to something like “All buffer space can be reused when the last reference is dropped” for clarity.
Suggested change
| /// All the buffers space to be reused when the last reference to it is dropped. | |
| /// All buffer space can be reused when the last reference is dropped. |
Contributor
|
Please address the Copilot feedback. |
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
re-usedin a source comment indiskioRelated issue
Guideline alignment
Validation
git diff --check