docs: add link to PollSender #3613
Merged
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
Signed-off-by: Zahari Dichev <zaharidichev@gmail.com>
Darksonn
added
A-tokio
Darksonn
reviewed
Mar 12, 2021
tokio/src/sync/mpsc/bounded.rs
Outdated
Comment on lines
317
to
318
| /// Sends a value, waiting until there is capacity. | ||
| /// Sends a value, waiting until there is capacity. In case you need a | ||
| /// polling interface, use [`PollSender`]. |
There was a problem hiding this comment.
I would like the link to be in the same place in the docs as where I put the similar thing for Semaphore.
tokio/src/sync/mpsc/bounded.rs
Outdated
| @@ -332,6 +333,7 @@ impl<T> Sender<T> { | |||
| /// | |||
| /// [`close`]: Receiver::close | |||
| /// [`Receiver`]: Receiver | |||
| /// [`PollSender`]: https://docs.rs/tokio-util/0.6.4/tokio_util/sync/struct.PollSender.html | |||
There was a problem hiding this comment.
Suggested change
| /// [`PollSender`]: https://docs.rs/tokio-util/0.6.4/tokio_util/sync/struct.PollSender.html | |
| /// [`PollSender`]: https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSender.html |
There was a problem hiding this comment.
Why don't we just put /latest/ here instead of concrete version?
There was a problem hiding this comment.
The link may break if we move it or remove it in future versions of tokio-util.
There was a problem hiding this comment.
Good to know, thanks!
Darksonn
reviewed
Mar 12, 2021
tokio/src/sync/mpsc/bounded.rs
Outdated
Comment on lines
312
to
315
| /// To use the `Sender` in a poll function, you can use the [`PollSender`] | ||
| /// utility. | ||
| /// | ||
| /// [`PollSender`]: https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSender.html |
There was a problem hiding this comment.
Put it on the struct, not the impl block.
Signed-off-by: Zahari Dichev <zaharidichev@gmail.com>
davidpdrsn
approved these changes
Mar 16, 2021
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.
Motivation
There was no link to
PollSenderin mpsc::Sender::send docsSolution
Add link
Fix: #3611