Skip to content

collect doc alias as tips during resolution #127721

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

collect doc alias as tips during resolution #127721

wants to merge 1 commit into from
+347 −32

Conversation

bvanjoi
Copy link
Contributor

@bvanjoi bvanjoi commented Jul 14, 2024

Close #124273

Collect the symbol in the doc alias attributes and provide a tip when a match is found.

r? @estebank

@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 Jul 14, 2024
@petrochenkov petrochenkov self-assigned this Jul 14, 2024
@petrochenkov
Copy link
Contributor

In general I'd prefer to maybe not do this at all for the local crate.
It will simplify things and avoid doing work on a good path.
The crate authors are the same people who write the doc alias attributes, so these hints are unlikely to be useful for them.

@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 16, 2024
@bvanjoi
Copy link
Contributor Author

bvanjoi commented Jul 16, 2024

I'd prefer to maybe not do this at all for the local crate.

Agree and accept this suggestion.

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 16, 2024
@petrochenkov petrochenkov removed their assignment Jul 16, 2024
@bors

This comment was marked as resolved.

Sign in to view
@lolbinarycat lolbinarycat added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 30, 2024
@lolbinarycat
Copy link
Contributor

@bvanjoi triage here, any interest in rebasing this?

@alex-semenyuk
Copy link
Member

@bvanjoi
Form wg-triage. Could you please rebase that it will be ready for review?

@bvanjoi
Copy link
Contributor Author

bvanjoi commented Oct 11, 2024

Rebased. @rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 11, 2024
@bors

This comment was marked as resolved.

Sign in to view
@bvanjoi
Copy link
Contributor Author

bvanjoi commented Oct 13, 2024

Update: Fixes the incorrect submodule...

@bors

This comment was marked as resolved.

Sign in to view
@wesleywiser
Copy link
Member

Hi @estebank could you take a look at this when you get a chance? Thanks 🙂

@jieyouxu
Copy link
Member

jieyouxu commented May 8, 2025

Maybe r? @petrochenkov (or reroll)?

@rustbot rustbot assigned petrochenkov and unassigned estebank May 8, 2025
petrochenkov
petrochenkov reviewed May 9, 2025
View reviewed changes
compiler/rustc_resolve/src/late/diagnostics.rs Outdated
} else {
let mod_path = &path[..path.len() - 1];
if let PathResult::Module(ModuleOrUniformRoot::Module(module)) =
self.resolve_path(mod_path, Some(TypeNS), None)
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think the logic is right, we are reporting an error for one specific unresolved segment in a path (and it's not necessarily the last one), not for all segments, and all segments before the one unresolved segment should be already resolved and recorded into partial_res_map.

So

  • no need to search candidates for all segments, only for the currently unresolved one
  • no need to use resolve_path for the previous segments, partial_res_map should already be filled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no need to search candidates for all segments, only for the currently unresolved one

I'm not sure what the point of 'all segments' is, because right now, it only searches in the module where the unresolved item is located.

@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 9, 2025
@rustbot rustbot added the A-attributes Area: Attributes (`#[…]`, `#![…]`) label May 12, 2025
@rustbot
Copy link
Collaborator

rustbot commented May 12, 2025

Some changes occurred in compiler/rustc_attr_parsing

cc @jdonszelmann

@bvanjoi
Copy link
Contributor Author

bvanjoi commented May 13, 2025

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 13, 2025
petrochenkov
petrochenkov reviewed May 13, 2025
View reviewed changes
compiler/rustc_resolve/src/late/diagnostics.rs Outdated
}
}
} else {
let mod_seg = path[path.len() - 2];
Copy link
Contributor

@petrochenkov petrochenkov May 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The unresolved segment is not necessarily last, index of the unresolved segment can be obtained using partial_res.unresolved_segments() in smart_resolve_path_fragment (or it's 0 if there is no partial resolution).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used an iterator for path segments because we cannot determine the position of the first unresolved segment in advance (meaning we don't know which item's unresolved_segment property will be works).

@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 13, 2025
bvanjoi
bvanjoi commented May 14, 2025
View reviewed changes
compiler/rustc_resolve/src/late/diagnostics.rs
}
}
} else {
for (idx, seg) in path.iter().enumerate().rev().skip(1) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use skip(1) because that the last segment must remain unresolved in the current logic, regardless of whether it's the first unresolved segment.

Copy link
Member

Choose a reason for hiding this comment

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

Can you leave a comment to that effect? It's otherwise very opaque.

@bvanjoi
Copy link
Contributor Author

bvanjoi commented May 14, 2025

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petrochenkov petrochenkov petrochenkov left review comments

@jieyouxu jieyouxu jieyouxu left review comments

Assignees

@petrochenkov petrochenkov

Labels
A-attributes Area: Attributes (`#[…]`, `#![…]`) 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support rustc_confusables on items other than methods
9 participants
@bvanjoi @petrochenkov @bors @lolbinarycat @alex-semenyuk @wesleywiser @jieyouxu @rustbot @estebank