When suggesting method names, prefer *exact* doc aliases over similar names - #160369
Open
joshtriplett wants to merge 2 commits into
Open
When suggesting method names, prefer *exact* doc aliases over similar names#160369joshtriplett wants to merge 2 commits into
joshtriplett wants to merge 2 commits into
Conversation
Collaborator
|
rustbot has assigned @petrochenkov. Use Why was this reviewer chosen?The reviewer was selected based on:
|
This comment has been minimized.
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
force-pushed
the
suggest-exact-alias-before-similar-name
branch
from
August 2, 2026 07:49
d08b388 to
32c2ca0
Compare
Member
Author
|
Fixed. One other test changed, for the better I think. An attempt to call |
Contributor
|
@bors r+ |
Contributor
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.
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
…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.
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`)
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
4 participants
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.
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 orrustc_confusablesentry will take precedence.The net result of this is that
read_exact_bufwill now produce a suggestion forread_buf_exact, notread_exact, if both exist and the former has a doc alias forread_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.