about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMara Bos <m-ou.se@m-ou.se>2021-03-08 20:09:03 +0100
committerGitHub <noreply@github.com>2021-03-08 20:09:03 +0100
commita55b192d5942efcaad6901dcd21ffe28316ca20a (patch)
tree68be4f389285c67af27916d30dfe77c2246460d2
parent6a55aa1246114dcfffc022fd5218336c25dab1a4 (diff)
parentc40ef91f7652f37c9bc959953bb4a81d86c2dc1a (diff)
downloadrust-a55b192d5942efcaad6901dcd21ffe28316ca20a.tar.gz
rust-a55b192d5942efcaad6901dcd21ffe28316ca20a.zip
Rollup merge of #82870 - jfrimmel:improve-docs, r=jyn514
Add note about the `#[doc(no-inline)]` usage

This is required to correctly build the documentation (including all submodules, that are only available in certain targets).

See the linked issue and #82861 for reference.
-rw-r--r--library/std/src/lib.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/library/std/src/lib.rs b/library/std/src/lib.rs
index acdf7550fe7..cebe05c39cb 100644
--- a/library/std/src/lib.rs
+++ b/library/std/src/lib.rs
@@ -395,7 +395,11 @@ pub use alloc_crate::vec;
 #[stable(feature = "rust1", since = "1.0.0")]
 pub use core::any;
 #[stable(feature = "simd_arch", since = "1.27.0")]
-#[doc(no_inline)]
+// The `no_inline`-attribute is required to make the documentation of all
+// targets available.
+// See https://github.com/rust-lang/rust/pull/57808#issuecomment-457390549 for
+// more information.
+#[doc(no_inline)] // Note (#82861): required for correct documentation
 pub use core::arch;
 #[stable(feature = "core_array", since = "1.36.0")]
 pub use core::array;