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.

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

Don't rename imports to _ in prelude #1593

Closed
Darksonn opened this issue Sep 23, 2019 · 1 comment
Closed

Don't rename imports to _ in prelude #1593

Darksonn opened this issue Sep 23, 2019 · 1 comment

Comments

@Darksonn
Copy link
Contributor

Please don't rename all those traits to _ in prelude. It makes navigating the documentation of the crate much more difficult, especially since the all the links in the documentation go to trait._.html, which happens to be one of the FutureExt traits.

pub use crate::future::FutureExt as _;
pub use futures_util::future::FutureExt as _;
pub use std::future::Future;
pub use crate::stream::{Stream, StreamExt as _};
pub use futures_sink::Sink;
pub use futures_util::sink::SinkExt as _;
pub use futures_util::stream::StreamExt as _;
#[cfg(feature = "io")]
pub use tokio_io::{
AsyncBufRead, AsyncBufReadExt as _, AsyncRead, AsyncReadExt as _, AsyncWrite,
AsyncWriteExt as _,
};

@taiki-e
Copy link
Member

taiki-e commented Sep 23, 2019

It makes navigating the documentation of the crate much more difficult, especially since the all the links in the documentation go to trait._.html, which happens to be one of the FutureExt traits.

I believe this can be avoided by using #[doc(no_inline)]. (see rust-lang/futures-rs#1662 (comment))

jothan added a commit to jothan/tokio that referenced this issue Sep 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants