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).
This commit is contained in:
Julian Frimmel 2021-03-07 10:52:35 +01:00
parent 51748a8fc7
commit c40ef91f76
1 changed files with 5 additions and 1 deletions

View File

@ -394,7 +394,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;