From 5f276c73b17f8ab60c3d8a75d99296565af722df Mon Sep 17 00:00:00 2001 From: Nipunn Koorapati Date: Fri, 20 Aug 2021 13:30:14 -0700 Subject: [PATCH] Prefer doc(no_inline) to doc(hidden) for reexports Fixes #2472 --- futures-core/src/lib.rs | 4 ++-- futures-util/src/lib.rs | 8 ++++---- futures/src/lib.rs | 16 ++++++++-------- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/futures-core/src/lib.rs b/futures-core/src/lib.rs index 35666065c2..9c31d8d90b 100644 --- a/futures-core/src/lib.rs +++ b/futures-core/src/lib.rs @@ -16,11 +16,11 @@ extern crate alloc; pub mod future; -#[doc(hidden)] +#[doc(no_inline)] pub use self::future::{FusedFuture, Future, TryFuture}; pub mod stream; -#[doc(hidden)] +#[doc(no_inline)] pub use self::stream::{FusedStream, Stream, TryStream}; #[macro_use] diff --git a/futures-util/src/lib.rs b/futures-util/src/lib.rs index 9cbca776cb..d8e41a3855 100644 --- a/futures-util/src/lib.rs +++ b/futures-util/src/lib.rs @@ -301,18 +301,18 @@ macro_rules! delegate_all { } pub mod future; -#[doc(hidden)] +#[doc(no_inline)] pub use crate::future::{Future, FutureExt, TryFuture, TryFutureExt}; pub mod stream; -#[doc(hidden)] +#[doc(no_inline)] pub use crate::stream::{Stream, StreamExt, TryStream, TryStreamExt}; #[cfg(feature = "sink")] #[cfg_attr(docsrs, doc(cfg(feature = "sink")))] pub mod sink; #[cfg(feature = "sink")] -#[doc(hidden)] +#[doc(no_inline)] pub use crate::sink::{Sink, SinkExt}; pub mod task; @@ -327,7 +327,7 @@ pub mod compat; pub mod io; #[cfg(feature = "io")] #[cfg(feature = "std")] -#[doc(hidden)] +#[doc(no_inline)] pub use crate::io::{ AsyncBufRead, AsyncBufReadExt, AsyncRead, AsyncReadExt, AsyncSeek, AsyncSeekExt, AsyncWrite, AsyncWriteExt, diff --git a/futures/src/lib.rs b/futures/src/lib.rs index 81fb83d15e..ff2a3d88fd 100644 --- a/futures/src/lib.rs +++ b/futures/src/lib.rs @@ -102,26 +102,26 @@ compile_error!("The `bilock` feature requires the `unstable` feature as an expli #[cfg(all(feature = "read-initializer", not(feature = "unstable")))] compile_error!("The `read-initializer` feature requires the `unstable` feature as an explicit opt-in to unstable features"); -#[doc(hidden)] +#[doc(no_inline)] pub use futures_core::future::{Future, TryFuture}; -#[doc(hidden)] +#[doc(no_inline)] pub use futures_util::future::{FutureExt, TryFutureExt}; -#[doc(hidden)] +#[doc(no_inline)] pub use futures_core::stream::{Stream, TryStream}; -#[doc(hidden)] +#[doc(no_inline)] pub use futures_util::stream::{StreamExt, TryStreamExt}; -#[doc(hidden)] +#[doc(no_inline)] pub use futures_sink::Sink; -#[doc(hidden)] +#[doc(no_inline)] pub use futures_util::sink::SinkExt; #[cfg(feature = "std")] -#[doc(hidden)] +#[doc(no_inline)] pub use futures_io::{AsyncBufRead, AsyncRead, AsyncSeek, AsyncWrite}; #[cfg(feature = "std")] -#[doc(hidden)] +#[doc(no_inline)] pub use futures_util::{AsyncBufReadExt, AsyncReadExt, AsyncSeekExt, AsyncWriteExt}; // Macro reexports