Fix --document-private-items not documenting private re-exports of hi…#159146
Open
mansiverma897993 wants to merge 1 commit into
Open
Fix --document-private-items not documenting private re-exports of hi…#159146mansiverma897993 wants to merge 1 commit into
mansiverma897993 wants to merge 1 commit into
Conversation
Collaborator
|
Thanks for the pull request, and welcome! The Rust Project is excited to review your changes, and you should hear from @GuillaumeGomez (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:
|
Collaborator
|
The job Click to see the possible cause of the failure (guessed by this bot) |
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.
Fixes #159109
Under
--document-private-items,rustdocis expected to document private items and private re-exports. However, when a private re-export (e.g.pub(crate) use) with#[doc(inline)]points to a private/hidden item, it was not being documented.Root Cause
src/librustdoc/visit_ast.rs, the AST is traversed to find items to document.RustdocVisitordetermines if an item/module is public (is_pubandinside_public_path) based on whether its visibility is public.is_pubwas computed asfalse, and local inlining (maybe_inline_local) was skipped.ImportItemin the clean representation and was subsequently stripped by thestrip-hiddenpass because the target item was marked#[doc(hidden)].Fix
RustdocVisitorinsrc/librustdoc/visit_ast.rsto treat private items, parent modules, and foreign items as public (making them eligible for local inlining) whendocument_privateis active.clean_extern_crateinsrc/librustdoc/clean/mod.rsto allow inlining of privateextern cratestatements ifdocument_privateis active.tests/rustdoc-html/document-private-items-reexports.rsthat validates private re-exports are correctly documented.