Skip to content

docs: fix disk buffer comment wording #4817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rohan5commit wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

docs: fix disk buffer comment wording #4817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/diskio/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ pub(crate) enum FileBuffer {
}

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.
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
pub(crate) fn clear(&mut self) {
if let FileBuffer::Threaded(contents) = self {
contents.clear()
Expand Down
Loading