Skip to content

When suggesting method names, prefer *exact* doc aliases over similar names - #160369

Merged
rust-bors[bot] merged 2 commits into
rust-lang:mainfrom
joshtriplett:suggest-exact-alias-before-similar-name
Aug 4, 2026
Merged

rust-bors[bot] merged 2 commits into
rust-lang:mainfrom
joshtriplett:suggest-exact-alias-before-similar-name

Conversation

@joshtriplett

@joshtriplett joshtriplett commented Aug 2, 2026 •

Copy link
Copy Markdown
Member

We currently prefer candidates from a similarity search over doc aliases or rustc_confusables, even though the latter requires an exact match. Reverse this order, so that an exactly matching doc alias or rustc_confusables entry will take precedence.

The net result of this is that read_exact_buf will now produce a suggestion for read_buf_exact, not read_exact, if both exist and the former has a doc alias for read_exact_buf.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Aug 2, 2026
@rustbot

rustbot commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator

r? @petrochenkov

rustbot has assigned @petrochenkov.
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: compiler
  • compiler expanded to 75 candidates
  • Random selection from 18 candidates

@rust-log-analyzer

This comment has been minimized.

… names

We currently prefer candidates from a similarity search over doc aliases
or `rustc_confusables`, even though the latter requires an *exact*
match. Reverse this order, so that an exactly matching doc alias or
`rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a
suggestion for `read_buf_exact`, not `read_exact`, if both exist and the
former has a doc alias for `read_exact_buf`.
@joshtriplett
joshtriplett force-pushed the suggest-exact-alias-before-similar-name branch from d08b388 to 32c2ca0 Compare August 2, 2026 07:49
@joshtriplett

joshtriplett commented Aug 2, 2026 •

Copy link
Copy Markdown
Member Author

Fixed. One other test changed, for the better I think. An attempt to call .size() now suggests only .len(), rather than .resize(...). That seems much more likely to be what the user wants, which is why we have a rustc_confusables on len.

@petrochenkov

Copy link
Copy Markdown
Contributor

@bors r+

@rust-bors

rust-bors Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 32c2ca0 has been approved by petrochenkov

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 Aug 3, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
…efore-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
JonathanBrouwer pushed a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
…uf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
…uwer

Rollup of 21 pull requests

Successful merges:

 - #159844 (Subtree cg_gcc sync (2026-07-24))
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160007 (allow `-Ldependency` search paths for panic runtimes)
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159014 ([rustdoc] Do not take `doc(cfg())` into account when filtering doctests)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160165 (reject `...` without pattern post-expansion)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
…efore-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
…uwer

Rollup of 23 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160007 (allow `-Ldependency` search paths for panic runtimes)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160435 (bump tracing-tree)
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
…efore-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 3, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
rust-bors Bot pushed a commit that referenced this pull request Aug 4, 2026
…uwer

Rollup of 26 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #158727 (std: use `readdir` on nearly all UNIX platforms)
 - #159130 (a bit optimize four-digit chunks in integer formatting)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - #160435 (bump tracing-tree)
 - #160449 (Fix lookup of object files)
jhpratt added a commit to jhpratt/rust that referenced this pull request Aug 4, 2026
…efore-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
jhpratt added a commit to jhpratt/rust that referenced this pull request Aug 4, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
jhpratt added a commit to jhpratt/rust that referenced this pull request Aug 4, 2026
…efore-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
jhpratt added a commit to jhpratt/rust that referenced this pull request Aug 4, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
@joshtriplett joshtriplett added the relnotes Marks issues that should be documented in the release notes of the next release. label Aug 4, 2026
rust-bors Bot pushed a commit that referenced this pull request Aug 4, 2026
Rollup of 28 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #159130 (a bit optimize four-digit chunks in integer formatting)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - #160427 (Run try builds on EC2 by default)
 - #160435 (bump tracing-tree)
 - #160449 (Fix lookup of object files)
 - #160477 (Update the tracking issue for `borrowed_buf_init`)
rust-bors Bot pushed a commit that referenced this pull request Aug 4, 2026
Rollup of 28 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #159130 (a bit optimize four-digit chunks in integer formatting)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - #160427 (Run try builds on EC2 by default)
 - #160435 (bump tracing-tree)
 - #160449 (Fix lookup of object files)
 - #160477 (Update the tracking issue for `borrowed_buf_init`)
rust-bors Bot pushed a commit that referenced this pull request Aug 4, 2026
Rollup of 28 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #159130 (a bit optimize four-digit chunks in integer formatting)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - #160427 (Run try builds on EC2 by default)
 - #160435 (bump tracing-tree)
 - #160449 (Fix lookup of object files)
 - #160477 (Update the tracking issue for `borrowed_buf_init`)
Kobzol added a commit to Kobzol/rust that referenced this pull request Aug 4, 2026
… r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang#160369 goes in, it'll also help
people find them as rustfix suggestions.
rust-bors Bot pushed a commit that referenced this pull request Aug 4, 2026
Rollup of 29 pull requests

Successful merges:

 - #153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - #159130 (a bit optimize four-digit chunks in integer formatting)
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #160434 (Avoid Docker push when the image did not change)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160011 (remove InterpError::map_err_info)
 - #160165 (reject `...` without pattern post-expansion)
 - #160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
 - #160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - #160427 (Run try builds on EC2 by default)
 - #160435 (bump tracing-tree)
 - #160449 (Fix lookup of object files)
 - #160477 (Update the tracking issue for `borrowed_buf_init`)
@rust-bors
rust-bors Bot merged commit 45b9518 into rust-lang:main Aug 4, 2026
13 checks passed
@rustbot rustbot added this to the 1.99.0 milestone Aug 4, 2026
rust-timer added a commit that referenced this pull request Aug 4, 2026
Rollup merge of #160369 - joshtriplett:suggest-exact-alias-before-similar-name, r=petrochenkov

When suggesting method names, prefer *exact* doc aliases over similar names

We currently prefer candidates from a similarity search over doc aliases or `rustc_confusables`, even though the latter requires an *exact* match. Reverse this order, so that an exactly matching doc alias or `rustc_confusables` entry will take precedence.

The net result of this is that `read_exact_buf` will now produce a suggestion for `read_buf_exact`, not `read_exact`, if both exist and the former has a doc alias for `read_exact_buf`.

Note that this makes method searches consistent with standalone function searches, because for the latter we already prefer doc aliases over similarity searches.
rust-timer added a commit that referenced this pull request Aug 4, 2026
Rollup merge of #160371 - joshtriplett:read_exact_buf_alias, r=Mark-Simulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
#160369 goes in, it'll also help
people find them as rustfix suggestions.
WhySoBad pushed a commit to WhySoBad/miri that referenced this pull request Aug 5, 2026
…imulacrum

Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`

When fingers really want to type `read_exact`, that naturally leads to
the typo `read_exact_buf` instead of `read_buf_exact`, and
`read_exact_buf_at` instead of `read_buf_exact_at`.

Add doc aliases.

These will help people find them in rustdoc, and once
rust-lang/rust#160369 goes in, it'll also help
people find them as rustfix suggestions.
WhySoBad pushed a commit to WhySoBad/miri that referenced this pull request Aug 5, 2026
Rollup of 29 pull requests

Successful merges:

 - rust-lang/rust#153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - rust-lang/rust#159130 (a bit optimize four-digit chunks in integer formatting)
 - rust-lang/rust#159326 (Deny multiple EII impls on a single item)
 - rust-lang/rust#159535 (Optimize slice::contains for bytewise types)
 - rust-lang/rust#159595 (Promote loongarch32-unknown-none* to Tier 2)
 - rust-lang/rust#160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - rust-lang/rust#160320 (point at trait definition when it is used as a derive macro)
 - rust-lang/rust#160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - rust-lang/rust#160406 (`DepKind` cleanups)
 - rust-lang/rust#160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - rust-lang/rust#160434 (Avoid Docker push when the image did not change)
 - rust-lang/rust#159303 (Fix ICE for direct inline const generic defaults)
 - rust-lang/rust#159977 (Add regression test for bool indexing codegen)
 - rust-lang/rust#160011 (remove InterpError::map_err_info)
 - rust-lang/rust#160165 (reject `...` without pattern post-expansion)
 - rust-lang/rust#160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - rust-lang/rust#160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - rust-lang/rust#160305 (Linkify C-SKY targets in `platform-support.md`)
 - rust-lang/rust#160314 (fix borrowck ICE for consts with fn pointer type)
 - rust-lang/rust#160322 (ElaborateBoxDeref: remove unnecessary projection)
 - rust-lang/rust#160338 (Add regression test for supertrait associated type normalization through dyn)
 - rust-lang/rust#160340 (Add regression test for unused_parens on contract clauses)
 - rust-lang/rust#160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - rust-lang/rust#160384 (Add PR body notes for Cargo lock file maintenance)
 - rust-lang/rust#160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - rust-lang/rust#160427 (Run try builds on EC2 by default)
 - rust-lang/rust#160435 (bump tracing-tree)
 - rust-lang/rust#160449 (Fix lookup of object files)
 - rust-lang/rust#160477 (Update the tracking issue for `borrowed_buf_init`)
flip1995 pushed a commit to flip1995/rust-clippy that referenced this pull request Aug 17, 2026
Rollup of 29 pull requests

Successful merges:

 - rust-lang/rust#153749 (Account for ownership mismatch on argument that doesn't meet bound)
 - rust-lang/rust#159130 (a bit optimize four-digit chunks in integer formatting)
 - rust-lang/rust#159326 (Deny multiple EII impls on a single item)
 - rust-lang/rust#159535 (Optimize slice::contains for bytewise types)
 - rust-lang/rust#159595 (Promote loongarch32-unknown-none* to Tier 2)
 - rust-lang/rust#160184 (Add -Zinstrument-mcount={fentry-nop-record,fentry-record})
 - rust-lang/rust#160320 (point at trait definition when it is used as a derive macro)
 - rust-lang/rust#160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - rust-lang/rust#160406 (`DepKind` cleanups)
 - rust-lang/rust#160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - rust-lang/rust#160434 (Avoid Docker push when the image did not change)
 - rust-lang/rust#159303 (Fix ICE for direct inline const generic defaults)
 - rust-lang/rust#159977 (Add regression test for bool indexing codegen)
 - rust-lang/rust#160011 (remove InterpError::map_err_info)
 - rust-lang/rust#160165 (reject `...` without pattern post-expansion)
 - rust-lang/rust#160172 (tests: Enable `feature(stmt_expr_attributes)` in `2229_closure_analysis` tests)
 - rust-lang/rust#160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - rust-lang/rust#160305 (Linkify C-SKY targets in `platform-support.md`)
 - rust-lang/rust#160314 (fix borrowck ICE for consts with fn pointer type)
 - rust-lang/rust#160322 (ElaborateBoxDeref: remove unnecessary projection)
 - rust-lang/rust#160338 (Add regression test for supertrait associated type normalization through dyn)
 - rust-lang/rust#160340 (Add regression test for unused_parens on contract clauses)
 - rust-lang/rust#160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - rust-lang/rust#160384 (Add PR body notes for Cargo lock file maintenance)
 - rust-lang/rust#160412 (Move duplicate-names check for #[rustc_must_implement_one_of] to attribute parser)
 - rust-lang/rust#160427 (Run try builds on EC2 by default)
 - rust-lang/rust#160435 (bump tracing-tree)
 - rust-lang/rust#160449 (Fix lookup of object files)
 - rust-lang/rust#160477 (Update the tracking issue for `borrowed_buf_init`)
@joshtriplett
joshtriplett deleted the suggest-exact-alias-before-similar-name branch September 3, 2026 07:56
dressupgeekout pushed a commit to dressupgeekout/pkgsrc-wip that referenced this pull request Oct 2, 2026
Pkgsrc changes:
 * Adapt to changes in vendored crate versions.
 * Version & checksum changes.

Upstream changes:

Version 1.99.0 (2026-10-01)
==========================

Language
--------
- [Add allow-by-default `raw_borrows_via_references` lint that
  checks for references that decay immediately into raw
  borrows](rust-lang/rust#138230)
- [Extend `unconditional_panic` lint to function calls that panic
  when the chunks/windows size is zero]
  (rust-lang/rust#153563)
- [Stabilize C-variadic function definitions]
  (rust-lang/rust#155697)
- [Stabilize the ability to use `#[unsafe(naked)]` functions to
  define C-variadic functions (`#![feature(c_variadic_naked_functions)]`).]
  (rust-lang/rust#159746)
- [Trait methods are now resolved on an adjusted never type (producing a FCW)]
  (rust-lang/rust#156047)
- [Coerce from inference variables to trait objects if the inference
  variable is related via subtyping to a type that is known to be `Sized`]
  (rust-lang/rust#157820)
- [Stabilize `#[my_macro] mod foo;`]
  (rust-lang/rust#157857). This allows
  outlined modules (`mod foo;`) anywhere in the body of a custom
  attribute or derive macro.
- [Fix the `overflowing_literals` lint with repeated negation]
  (rust-lang/rust#158302). For instance,
  it will now no longer lint on `--128_i8`, which is already detected
  by the `arithmetic_overflow` lint.
- [Add POSIX symbols to the `invalid_runtime_symbol_definitions`
  and `suspicious_runtime_symbol_definitions` lints]
  (rust-lang/rust#158522)
- [Lint unused `#[path]` attributes on inline modules]
  (rust-lang/rust#158835)
- [Enable `unreachable_cfg_select_predicates` lint as part of
  `unused` lint group] (rust-lang/rust#159179)
- [Stabilize passing 128-bit integers via vector registers with `asm!` on x86]
  (rust-lang/rust#159525)
- [Explicitly document that some allocations are allowed to grow
  in-place (but none are allowed to shrink)]
  (rust-lang/rust#159729)
- We now [guarantee]
  (rust-lang/rust#159730) that the contents
  of an `UnsafeCell` can be accessed without going through `get`
  - [The `invalid_reference_casting` lint was adjusted accordingly]
  (rust-lang/rust#159960)
- [Account for globally enabled target features in `global_asm!`]
  (rust-lang/rust#160594)
- [Warn if an invalid `doc` attribute is used on a macro invocation]
  (rust-lang/rust#161003)

Compiler
--------
- [Convert `-Ctarget-cpu` into a target-modifier for AVR, AMDGCN and NVPTX]
  (rust-lang/rust#150732)
- [Enable `static_position_independent_executables` on all gnu and musl targets]
  (rust-lang/rust#158510)
- When providing a suggestion about a missing method, rustc now
  prefers an exactly matching name from a [doc alias attribute]
  (https://doc.rust-lang.org/rustdoc/advanced-features.html#add-aliases-for-an-item-in-documentation-search)
  over a similarity search from other method names. If your new
  users sometimes expect a method under a different name, adding
  a doc alias will now help them find it via rustc suggestions, in
  addition to helping them find it via rustdoc search: [When
  suggesting method names, prefer *exact* doc aliases over similar
  names](rust-lang/rust#160369)

Platform Support
----------------
- [Promote `riscv64-unknown-linux-musl` to Tier 2 with host tools]
  (rust-lang/rust#158766)

Refer to Rust's [platform support page][platform-support-doc]
for more information on Rust's tiered platform support.

[platform-support-doc]: https://doc.rust-lang.org/rustc/platform-support.html

Libraries
---------
- Iteration on `RangeInclusive` (`a..=b` ranges) is now [optimized
  better in some circumstances]
  (rust-lang/rust#155114). As a side effect
  of this, the behavior of `RangeInclusive` values that has already
  been exhausted (as an iterator) has changed. For example, the
  return values of `start()` and `end()` on such ranges may return
  different values, and using such ranges as slice indexes may have
  different behavior. These behaviors were not guaranteed to be
  stable, so these changes are considered to not be breaking changes.
- [Relax `transmute_copy` to accept `?Sized` types]
  (rust-lang/rust#155989)
- [Update `transmute_copy` to use a non-unwinding panic]
  (rust-lang/rust#155989)
- [Don't escape U+FF9E and U+FF9F in `escape_debug_ext`]
  (rust-lang/rust#158057)
- [Re-export `core::fmt::NumBuffer` in `alloc` (and `std`)]
  (rust-lang/rust#161430)

Stabilized APIs
---------------

- [`IntoIterator` for `Box<[T; N]>`]
  (https://doc.rust-lang.org/stable/std/iter/trait.IntoIterator.html#impl-IntoIterator-for-Box%3C%5BT;+N%5D,+A%3E)
- [`IntoIterator` for `&Box<[T; N]>`]
  (https://doc.rust-lang.org/stable/std/iter/trait.IntoIterator.html#impl-IntoIterator-for-%26Box%3C%5BT;+N%5D,+A%3E)
- [`IntoIterator` for `&mut Box<[T; N]>`]
  (https://doc.rust-lang.org/stable/std/iter/trait.IntoIterator.html#impl-IntoIterator-for-%26mut+Box%3C%5BT;+N%5D,+A%3E)
- [`VecDeque::retain_back`]
  (https://doc.rust-lang.org/stable/std/collections/struct.VecDeque.html#method.retain_back)
- [`core::ffi::VaList`]
  (https://doc.rust-lang.org/stable/core/ffi/struct.VaList.html)
- [`Box::into_non_null`]
  (https://doc.rust-lang.org/stable/std/boxed/struct.Box.html#method.into_non_null)
- [`Box::from_non_null`]
  (https://doc.rust-lang.org/stable/std/boxed/struct.Box.html#method.from_non_null)
- [`Vec::into_parts`]
  (https://doc.rust-lang.org/stable/std/vec/struct.Vec.html#method.into_parts)
- [`Vec::from_parts`]
  (https://doc.rust-lang.org/stable/std/vec/struct.Vec.html#method.from_parts)
- [`core::mem::size_of_val_raw`]
  (https://doc.rust-lang.org/stable/core/mem/fn.size_of_val_raw.html)
- [`core::mem::align_of_val_raw`]
  (https://doc.rust-lang.org/stable/core/mem/fn.align_of_val_raw.html)
- [`core::alloc::Layout::for_value_raw`]
  (https://doc.rust-lang.org/stable/core/alloc/struct.Layout.html#method.for_value_raw)
- [`String::from_utf8_lossy_owned`]
  (https://doc.rust-lang.org/stable/std/string/struct.String.html#method.from_utf8_lossy_owned)
- [`string::FromUtf8Error::into_utf8_lossy`]
  (https://doc.rust-lang.org/stable/std/string/struct.FromUtf8Error.html#method.into_utf8_lossy)
- [`FusedIterator for StepBy<I>`]
  (https://doc.rust-lang.org/stable/std/iter/struct.StepBy.html#impl-FusedIterator-for-StepBy%3CI%3E)
- [`std::fs::set_times`]
  (https://doc.rust-lang.org/stable/std/fs/fn.set_times.html)
- [`std::fs::set_times_nofollow`]
  (https://doc.rust-lang.org/stable/std/fs/fn.set_times_nofollow.html)

Cargo
-----
- Add a new built-in profile `debug`. This is a preparation for
  transitioning the `dev` profile away from debugging to give a saner
  default for faster development iterations. Currently there is no
  difference between `dev` and `debug` profiles. [docs]
  (https://doc.rust-lang.org/nightly/cargo/reference/profiles.html#debug-1)
  [#17214] (rust-lang/cargo#17214)
- Workspace members on edition 2024 or later can now override an
  inherited workspace dependency's `default-features` field. For
  example, `serde = { workspace = true, default-features = false }`
  now turns off default features even when the workspace definition
  enables them. On earlier editions, `default-features = false` is
  ignored with a warning. ([RFC 3945]
  (rust-lang/rfcs#3945))
  [#17126](rust-lang/cargo#17126)
- Incremental compilation is now disabled by default when running
  in CI. CI is detected via the CI environment variable. [#17220]
  (rust-lang/cargo#17220)
  See also the [full Cargo changelog]
  (https://doc.rust-lang.org/nightly/cargo/CHANGELOG.html#cargo-199-2026-10-01)

Rustdoc
-----
- [Add new `unused_footnote_definition` rustdoc lint]
  (rust-lang/rust#137858)
- Smarter filtering of trait impls yields performance improvements
  of 20% on average and up to 40% on some real-world crates. ([1]
  (rust-lang/rust#159623),
  [2](rust-lang/rust#159721),
  [3](rust-lang/rust#159779),
  [4](rust-lang/rust#159854),
  [5](rust-lang/rust#159091))

Compatibility Notes
-------------------
- [Fully deprecate the legacy integral modules]
  (rust-lang/rust#146882). For example,
  `std::i32::MAX` should be accessed via `i32::MAX` instead.
- [Upgrade `no_mangle_generic_items` into hard error]
  (rust-lang/rust#154585)
- [The `Pin::new_unchecked` has had its safety invariants changed slightly]
  (rust-lang/rust#156935)
- [Do not promote references to extern statics]
  (rust-lang/rust#157641)
- [Ensure that the inferred types of `let` patterns typecheck]
  (rust-lang/rust#157841)
- [hermit/fs: Return `unsupported()` instead of `from_raw_os_error(22)`]
  (rust-lang/rust#158247)
- [Fixed a bug where `#[repr(simd)]` was accidentally allowed on
  macro invocations on stable Rust]
  (rust-lang/rust#158523)
- [Abort const-eval when there are generics in the type of the
  value being produced]
  (rust-lang/rust#159504)
- [Attributes not applying to anything are now an error in code
  blocks in doc comments]
  (rust-lang/rust#159849)
- [`Box::leak`: tell people to avoid unleaking]
  (rust-lang/rust#160323)
- [PowerPC inline ASM: Fix scalar floats being in the wrong vector
  lane on little endian] (rust-lang/rust#160441)
- [Do not take `doc(cfg())` into account when filtering doctests]
  (rust-lang/rust#159014)
- [Infer anonymous lifetimes in the types of associated consts as `'static`]
  (rust-lang/rust#156508)
- Macros that expand to a semicolon now produce a warning lint
  (`semicolon_in_expressions_from_non_local_macros`) even when the
  macro comes from another crate. Previously, such warnings only
  appeared for macros from the same crate, to avoid showing warnings
  that can't be fixed locally; however, this masked problems, as
  integration tests from the crate providing the macro get compiled
  as a separate crate, so tests often wouldn't reveal this issue. If
  you encounter a lint like this, please make sure to report it to
  the crate providing the macro so they can fix it; don't just silence
  it in your own crate.
  - [`semicolon_in_expressions_from_macros`: Lint on non-local
    macros too] (rust-lang/rust#159222)
  - [Split non-local `semicolon_in_expressions_from_macros` into
    a separate lint] (rust-lang/rust#159700)

Internal Changes
----------------

These changes do not affect any public interfaces of Rust, but they represent
significant improvements to the performance or internals of rustc and related
tools.

- [Update to LLVM 23]
  (rust-lang/rust#158734)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

relnotes Marks issues that should be documented in the release notes of the next release. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants