Consider doc(alias) when providing typo suggestions #107108
Merged
Conversation
This file contains 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
|
r? @Nilstrieb (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
S-waiting-on-review
Noratrieb
reviewed
Jan 20, 2023
sulami
force-pushed
the
issue-83968-doc-alias-typo-suggestions
branch
2 times, most recently
from
123d275 to
cf5e337
Compare
Noratrieb
reviewed
Jan 20, 2023
| if let sym::doc = attr.name_or_empty() { | ||
| if let Some(values) = attr.meta_item_list() { | ||
| for v in values { | ||
| if v.name_or_empty().as_str() != "alias" { |
There was a problem hiding this comment.
Could you add alias to the symbols table in rustc_span/src/symbols.rs (I think that was the path) instead of doing this string comparison?
mejrs
reviewed
Jan 20, 2023
sulami
force-pushed
the
issue-83968-doc-alias-typo-suggestions
branch
from
cf5e337 to
c67108b
Compare
Noratrieb
reviewed
Jan 21, 2023
sulami
force-pushed
the
issue-83968-doc-alias-typo-suggestions
branch
from
c67108b to
8c5843a
Compare
|
The implementation looks fine here. I think this is only invoked on error paths, so the extra computation when probing for candidates is fine. I have a few nits that you could address if you want:
|
sulami
force-pushed
the
issue-83968-doc-alias-typo-suggestions
branch
from
8c5843a to
b4af140
Compare
|
|
||
| Err(MethodError::NoMatch(NoMatchData { | ||
| static_candidates, | ||
| unsatisfied_predicates, | ||
| out_of_scope_traits, | ||
| lev_candidate, | ||
| lev_candidate: similar_candidate, |
There was a problem hiding this comment.
The field in NoMatchData should probably be renamed too.
compiler-errors
approved these changes
Jan 22, 2023
This means that
```rust
impl Foo {
#[doc(alias = "quux")]
fn bar(&self) {}
}
fn main() {
(Foo {}).quux();
}
```
will suggest `bar`. This currently uses the "there is a method with a
similar name" help text, because the point where we choose and emit a
suggestion is different from where we gather the suggestions. Changes
have mainly been made to the latter.
The selection code will now fall back to aliased candidates, but
generally only if there is no candidate that matches based on the
existing Levenshtein methodology.
Fixes rust-lang#83968.
sulami
force-pushed
the
issue-83968-doc-alias-typo-suggestions
branch
from
b4af140 to
f908f0b
Compare
|
@bors r+ |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 23, 2023
Rollup of 7 pull requests Successful merges: - rust-lang#104926 (Move relationships from FulfillmentContext to Inherited) - rust-lang#106854 (Add `Arc::into_inner` for safely discarding `Arc`s without calling the destructor on the inner type.) - rust-lang#107108 (Consider doc(alias) when providing typo suggestions) - rust-lang#107186 (rustdoc: Use correct pseudo-element selector) - rust-lang#107192 (Add myself to the mailmap) - rust-lang#107195 (Fix typo in universal_regions.rs comment) - rust-lang#107203 (Suggest remove deref for type mismatch) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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.
This means that
will suggest
bar. This currently uses the "there is a method with a similar name" help text, because the point where we choose and emit a suggestion is different from where we gather the suggestions. Changes have mainly been made to the latter.The selection code will now fall back to aliased candidates, but generally only if there is no candidate that matches based on the existing Levenshtein methodology.
Fixes #83968.