diff options
| author | QuietMisdreavus <grey@quietmisdreavus.net> | 2018-11-08 19:06:16 -0600 |
|---|---|---|
| committer | QuietMisdreavus <grey@quietmisdreavus.net> | 2018-11-09 09:07:57 -0600 |
| commit | 401cb6bb539e95733290d1b0487f682f48b3f9cd (patch) | |
| tree | 0e0407ac05b1c379c3ec4bff13a7b7b4599fef2f /src/doc/rustdoc | |
| parent | 653da4fd006c97625247acd7e076d0782cdc149b (diff) | |
| download | rust-401cb6bb539e95733290d1b0487f682f48b3f9cd.tar.gz rust-401cb6bb539e95733290d1b0487f682f48b3f9cd.zip | |
don't inline `pub use some_crate` unless directly asked to
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/the-doc-attribute.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index 296422744fa..61e5b3d0133 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -186,6 +186,9 @@ mod bar { Now we'll have a `Re-exports` line, and `Bar` will not link to anywhere. +One special case: In Rust 2018 and later, if you `pub use` one of your dependencies, `rustdoc` will +not eagerly inline it as a module unless you add `#[doc(inline)}`. + ## `#[doc(hidden)]` Any item annotated with `#[doc(hidden)]` will not appear in the documentation, unless |