fix: Do not stop visible_parent_map breadth-first search reaching children of #[doc(hidden)] modules#159881
Open
zalanlevai wants to merge 1 commit into
Open
Conversation
…hildren of `#[doc(hidden)]` modules
Collaborator
|
Thanks for the pull request, and welcome! The Rust Project is excited to review your changes, and you should hear from @fee1-dead (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
Why was this reviewer chosen?The reviewer was selected based on:
|
Author
|
@rustbot label +A-diagnostics +A-visibility |
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
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.
The
visible_parent_mapquery misses putting the child items of#[doc(hidden)]modules into the queue, resulting in the breadth-first search missing them entirely. This results in inconsistent path printing behavior affecting diagnostics: namely that re-exports nested deeply within#[doc(hidden)]modules are not considered as a possible fallback path. See the linked issue (#159880) for more details and an example of how this manifests in diagnostics.This PR makes sure that
#[doc(hidden)]parents in the fallback map are still searched as part of the breadth-first search.Fixes #159880.
The two tests for this change are based on the inconsistent diagnostics shown in the issue:
tests/ui/suggestions/suggest-path-through-direct-dep-crate/hidden-reexport-of-transitive-dep-item.rscaptures the current, expected behavior in the already working base case where the hidden module is still recorded in the fallback map;tests/ui/suggestions/suggest-path-through-direct-dep-crate/hidden-reexport-of-nested-transitive-dep-item.rsis a regression test for the breadth-first search covering nested children of#[doc(hidden)]modules to populate the fallback map by testing whether the diagnostic prefers the hidden but accessible path through the direct dependency crate.Related PRs/issues: