Skip to content

Ignore #[doc(hidden)] items when computing trimmed paths for printing #148623

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
Zalathar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Ignore #[doc(hidden)] items when computing trimmed paths for printing #148623

Zalathar wants to merge 2 commits into from
+360 −193

Conversation

@Zalathar
Copy link
Member

@Zalathar Zalathar commented Nov 7, 2025

The trimmed_def_paths query examines all items in the current crate, and all pub items in immediate-dependency crates (including the standard library), to see which item names are unique and can therefore be printed unambiguously as a bare name without a module path.

Currently that query has no special handling for #[doc(hidden)] items, which has two consequences:

  • Hidden names can be considered unique, and will therefore be printed without a path, making it hard to find where that name is defined (since it normally isn't listed in documentation).
  • Hidden names can conflict with visible names that would otherwise be considered unique, causing diagnostics to mysteriously become more verbose based on internal details of other crates.

This PR therefore makes the trimmed_def_paths query ignore external-crate items that are #[doc(hidden)], along with their descendants.

As a result, hidden item names are never considered unique for trimming, and no longer interfere with visible item names being considered unique.

@rustbot
Copy link
Collaborator

rustbot commented Nov 7, 2025

This PR modifies tests/ui/issues/. If this PR is adding new tests to tests/ui/issues/,
please refrain from doing so, and instead add it to more descriptive subdirectories.

@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 Nov 7, 2025
@rustbot
Copy link
Collaborator

rustbot commented Nov 7, 2025

r? @wesleywiser

rustbot has assigned @wesleywiser.
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

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@Zalathar Zalathar changed the title Ignore #[doc(hidden)] items when computing trimmed paths for diagnostics Ignore #[doc(hidden)] items when computing trimmed paths for printing Nov 8, 2025
@bors

This comment was marked as resolved.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@bors

This comment was marked as resolved.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@Zalathar Zalathar closed this Nov 14, 2025
@Zalathar Zalathar deleted the trimmed-paths branch November 14, 2025 02:19
@Zalathar Zalathar restored the trimmed-paths branch November 14, 2025 02:19
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 14, 2025
@Zalathar Zalathar reopened this Nov 14, 2025
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 14, 2025
@bors

This comment was marked as resolved.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@Zalathar
Copy link
Member Author

Zalathar commented Nov 29, 2025

@rustbot ready

@rustbot

This comment has been minimized.

Sign in to view
@Zalathar
Copy link
Member Author

Zalathar commented Dec 8, 2025

@rustbot ready

@rustbot

This comment has been minimized.

Sign in to view
@bors

This comment was marked as resolved.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@Zalathar
Copy link
Member Author

Zalathar commented Dec 28, 2025

Ah, looks like some of the conflicting files were not properly re-blessed due to debug assertions.

@rustbot

This comment has been minimized.

Sign in to view
@Zalathar
Copy link
Member Author

Zalathar commented Jan 5, 2026

r? compiler

@rustbot rustbot assigned davidtwco and unassigned wesleywiser Jan 5, 2026
@rust-bors

This comment was marked as resolved.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@rustbot

This comment has been minimized.

Sign in to view
@rust-bors

This comment has been minimized.

Sign in to view
@rustbot
Copy link
Collaborator

rustbot commented Jan 19, 2026

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

@davidtwco
Copy link
Member

davidtwco commented Jan 19, 2026

@bors r+

@rust-bors
Copy link
Contributor

rust-bors bot commented Jan 19, 2026

📌 Commit 2df2c72 has been approved by davidtwco

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 Jan 19, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Jan 19, 2026
@JonathanBrouwer
Rollup merge of rust-lang#148623 - trimmed-paths, r=davidtwco
619f137 
Ignore `#[doc(hidden)]` items when computing trimmed paths for printing

The `trimmed_def_paths` query examines all items in the current crate, and all pub items in immediate-dependency crates (including the standard library), to see which item names are unique and can therefore be printed unambiguously as a bare name without a module path.

Currently that query has no special handling for `#[doc(hidden)]` items, which has two consequences:
- Hidden names can be considered unique, and will therefore be printed without a path, making it hard to find where that name is defined (since it normally isn't listed in documentation).
- Hidden names can conflict with visible names that would otherwise be considered unique, causing diagnostics to mysteriously become more verbose based on internal details of other crates.

This PR therefore makes the `trimmed_def_paths` query ignore external-crate items that are `#[doc(hidden)]`, along with their descendants.

As a result, hidden item names are never considered unique for trimming, and no longer interfere with visible item names being considered unique.

---
- Fixes rust-lang#148387.
@JonathanBrouwer JonathanBrouwer mentioned this pull request Jan 19, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidtwco davidtwco davidtwco approved these changes

Assignees

@davidtwco davidtwco

Labels

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Standard library internal modules are treated as potential name colliders

6 participants

@Zalathar @rustbot @rust-log-analyzer @bors @davidtwco @wesleywiser