Add chapter in rustdoc book for re-exports and add a regression test for #[doc(hidden)] behaviour
#112304
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
requested changes
Jun 5, 2023
Comment on lines
236
to
237
| For name-based imports (such as `use module::Item as ModuleItem`), hiding an item acts the same as | ||
| making it private. For glob-based imports (such as `use module::*`), hidden items are not inlined. |
There was a problem hiding this comment.
This isn't really true any more, since doc(hidden) doesn't really act like making an item private any more.
There was a problem hiding this comment.
Arf, missed that one.
| In the generated documentation, you will see a re-export at the crate root and not the type | ||
| directly. | ||
|
|
||
| ## Attributes |
There was a problem hiding this comment.
I remember that this section was considered hard to understand, and needed replaced.
Now that there's so much detailed description above it, this section should probably just be removed.
There was a problem hiding this comment.
I actually think it's important to talk about "attribute inheritance". I think it can be simplified a lot though.
GuillaumeGomez
force-pushed
the
re-exports
branch
from
8099ebc
to
44b1365
Compare
|
Improved documentation and fixed the one I missed. |
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
notriddle
approved these changes
Jun 14, 2023
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 15, 2023
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#111212 (Add casting suggestion when assigning negative 2's complement bin or hex literal to a size compatible signed integer) - rust-lang#112304 (Add chapter in rustdoc book for re-exports and add a regression test for `#[doc(hidden)]` behaviour) - rust-lang#112486 (Fix suggestion for E0404 not dealing with multiple generics) - rust-lang#112562 (rustdoc-gui: allow running on Windows) - rust-lang#112621 (Mention `env!` in `option_env!`'s docs) - rust-lang#112634 (add InlineConst check) r? `@ghost` `@rustbot` modify labels: rollup
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 #109449.
Fixes #53417.
After the discussion in #109697, I made a few PRs to fix a few corner cases:
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