Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prefer doc(no_inline) to doc(hidden) for reexports #2479

Merged
merged 1 commit into from Aug 22, 2021
Merged

Prefer doc(no_inline) to doc(hidden) for reexports #2479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions futures-core/src/lib.rs
View file
Open in desktop
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
8 changes: 4 additions & 4 deletions futures-util/src/lib.rs
View file
Open in desktop
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
16 changes: 8 additions & 8 deletions futures/src/lib.rs
View file
Open in desktop
Expand Up @@ -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
Expand Down