Skip to content

bufreader::Buffer: Remove leftover note about initialized field#156026

Merged
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
InsertCreativityHere:patch-1
May 2, 2026
Merged

bufreader::Buffer: Remove leftover note about initialized field#156026
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
InsertCreativityHere:patch-1

Conversation

@InsertCreativityHere
Copy link
Copy Markdown
Contributor

Just a boring little doc fix! : v)

#150129 reworked the initialized field to be a bool instead of a usize.
And then #155314 reworked this field's comment (among other things).
But, there's still a leftover note in the comment, which no longer makes sense:
Note that while this often the same as `filled`, it doesn't need to be.
This is referencing that back when initialized was a usize, it was common for it to have the same value as filled.


Fun fact: there's a typo in the note too! It's missing an "is" before or after "often".

rust-lang#150129 reworked this field to use `bool` instead of `usize`, which is awesome!
But the field's comment has a leftover note in it which is no longer true, and that needs to be removed.
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels May 1, 2026
@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented May 1, 2026

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: @ChrisDenton, libs
  • @ChrisDenton, libs expanded to 8 candidates
  • Random selection from Mark-Simulacrum, jhpratt, nia-e

@jhpratt
Copy link
Copy Markdown
Member

jhpratt commented May 2, 2026

Thanks for the clarification…I definitely didn't see how this was wrong at first glance.

@bors r+ rollup

@rust-bors
Copy link
Copy Markdown
Contributor

rust-bors Bot commented May 2, 2026

📌 Commit 51e3797 has been approved by jhpratt

It is now in the queue for this repository.

@rust-bors rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 2, 2026
rust-bors Bot pushed a commit that referenced this pull request May 2, 2026
Rollup of 4 pull requests

Successful merges:

 - #154571 (Fix alias path for rustdoc)
 - #155749 (`-Znext-solver` Ignore region constraints from the nested goals in leakcheck)
 - #156026 (`bufreader::Buffer`: Remove leftover note about `initialized` field)
 - #156063 (Map `WSAESHUTDOWN` to `io::ErrorKind::BrokenPipe`)
@rust-bors rust-bors Bot merged commit 3bf51d0 into rust-lang:main May 2, 2026
11 checks passed
@rustbot rustbot added this to the 1.97.0 milestone May 2, 2026
rust-timer added a commit that referenced this pull request May 2, 2026
Rollup merge of #156026 - InsertCreativityHere:patch-1, r=jhpratt

`bufreader::Buffer`: Remove leftover note about `initialized` field

Just a boring little doc fix! : v)

#150129 reworked the `initialized` field to be a `bool` instead of a `usize`.
And then #155314 reworked this field's comment (among other things).
But, there's still a leftover note in the comment, which no longer makes sense:
``Note that while this often the same as `filled`, it doesn't need to be.``
This is referencing that back when `initialized` was a `usize`, it was common for it to have the same value as `filled`.

----

Fun fact: there's a typo in the note too! It's missing an "is" before or after "often".
@InsertCreativityHere
Copy link
Copy Markdown
Contributor Author

Thanks for the clarification…I definitely didn't see how this was wrong at first glance.

No problem! Thanks for the quick review! : v)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants