Document the typical value for an io param
#2568
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per rust-lang/rust#84824, it can be hard to figure out from the trait bounds what types meet those bounds.
seanmonstar
reviewed
Sep 16, 2021
src/client/conn.rs
Outdated
| @@ -87,7 +87,8 @@ where | |||
| H2(#[pin] proto::h2::ClientTask<B>, PhantomData<fn(T)>), | |||
| } | |||
|
|
|||
| /// Returns a handshake future over some IO. | |||
| /// Returns a handshake future over some IO. The io parameter will usually be a | |||
| /// [tokio::net::TcpStream](https://docs.rs/tokio/1.6.1/tokio/net/struct.TcpStream.html). | |||
There was a problem hiding this comment.
I wonder, so as to not encode the version directly into the source, can we just point at (tokio::net::TcpStream)? Also, I'd put the second sentence in a new line / new paragraph.
There was a problem hiding this comment.
Done! I tried just pointing at tokio::net::TcpStream with intradoc links, but it didn't work because that's behind a feature flag. Instead I replaced 1.6.1 with latest
|
As part of hyper 1.0, we're trying to de-couple the Tokio preference from hyper directly, but I do think we should have more guides telling people the most likely way they will do a thing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per rust-lang/rust#84824, it can be hard to figure out
from the trait bounds what types meet those bounds.