Skip to content

Commit

Permalink
Prefer doc(no_inline) to doc(hidden) for reexports
Browse files Browse the repository at this point in the history
  • Loading branch information
nipunn1313 committed Aug 20, 2021
1 parent 62d5aa5 commit 038ee7d
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions futures-core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions futures-util/src/async_await/join_mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ macro_rules! document_join_macro {
}

#[allow(unreachable_pub)]
#[doc(hidden)]
#[doc(no_inline)]
#[cfg_attr(not(fn_like_proc_macro), proc_macro_hack::proc_macro_hack(support_nested))]
pub use futures_macro::join_internal;

#[allow(unreachable_pub)]
#[doc(hidden)]
#[doc(no_inline)]
#[cfg_attr(not(fn_like_proc_macro), proc_macro_hack::proc_macro_hack(support_nested))]
pub use futures_macro::try_join_internal;

Expand Down
4 changes: 2 additions & 2 deletions futures-util/src/async_await/select_mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -308,12 +308,12 @@ macro_rules! document_select_macro {

#[cfg(feature = "std")]
#[allow(unreachable_pub)]
#[doc(hidden)]
#[doc(no_inline)]
#[cfg_attr(not(fn_like_proc_macro), proc_macro_hack::proc_macro_hack(support_nested))]
pub use futures_macro::select_internal;

#[allow(unreachable_pub)]
#[doc(hidden)]
#[doc(no_inline)]
#[cfg_attr(not(fn_like_proc_macro), proc_macro_hack::proc_macro_hack(support_nested))]
pub use futures_macro::select_biased_internal;

Expand Down
2 changes: 1 addition & 1 deletion futures-util/src/async_await/stream_select_mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#[cfg(feature = "std")]
#[allow(unreachable_pub)]
#[doc(hidden)]
#[doc(no_inline)]
#[cfg_attr(not(fn_like_proc_macro), proc_macro_hack::proc_macro_hack(support_nested))]
pub use futures_macro::stream_select_internal;

Expand Down
10 changes: 5 additions & 5 deletions futures-util/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pub use pin_utils::pin_mut;
#[macro_use]
mod async_await;
#[cfg(feature = "async-await")]
#[doc(hidden)]
#[doc(no_inline)]
pub use self::async_await::*;

// Not public API.
Expand Down Expand Up @@ -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;
Expand All @@ -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,
Expand Down

0 comments on commit 038ee7d

Please sign in to comment.