Fix re-export of doc hidden item inside private item not displayed #112108
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
rustbot
added
S-waiting-on-review
notriddle
reviewed
May 30, 2023
src/librustdoc/visit_ast.rs
Outdated
| let Some(item_def_id) = reexport_chain(tcx, def_id, res_did).iter() | ||
| let is_hidden = tcx.is_doc_hidden(ori_res_did); | ||
| let item = tcx.hir().get_by_def_id(res_did); | ||
| let is_module = matches!(item, Node::Item(&hir::Item { kind: hir::ItemKind::Mod(_), .. })); |
There was a problem hiding this comment.
Why does it matter if it's a module or not?
There was a problem hiding this comment.
Because if it's a module, it can contain items that could be re-exported and we need to to go through them too. A good example of this can be seen in tests/rustdoc/infinite-redirection.rs.
There was a problem hiding this comment.
I added a comment explaining it and moved this matches!() directly into the if condition.
GuillaumeGomez
force-pushed
the
reexport-doc-hidden-private
branch
from
cd4dd39 to
9906504
Compare
GuillaumeGomez
changed the title
|
@bors r+ |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 31, 2023
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#112031 (Migrate `item_proc_macro` to Askama) - rust-lang#112053 (Remove `-Zcgu-partitioning-strategy`.) - rust-lang#112069 (offset_of: don't require type to be `Sized`) - rust-lang#112084 (enhancements on build_helper utilization and rustdoc-gui-test) - rust-lang#112096 (Remove array_zip) - rust-lang#112108 (Fix re-export of doc hidden item inside private item not displayed) - rust-lang#112113 (rustdoc: simplify `clean` by removing `FnRetTy`) r? `@ghost` `@rustbot` modify labels: rollup
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jun 15, 2023
…ddle Add chapter in rustdoc book for re-exports and add a regression test for `#[doc(hidden)]` behaviour Fixes rust-lang#109449. Fixes rust-lang#53417. After the discussion in rust-lang#109697, I made a few PRs to fix a few corner cases: * rust-lang#112178 * rust-lang#112108 * rust-lang#111997 With this I think I covered all cases. Only thing missing at this point was a chapter covering re-exports in the rustdoc book. r? `@notriddle`
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 PR fixes this bug:
pub use crate::private_module::Public as Foo;should be visible in the generated doc (and not inlined!) but currently isn't. This PR fixes it.r? @notriddle