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

docs: add link to PollSender #3613

Merged
merged 3 commits into from
Mar 16, 2021
Merged

docs: add link to PollSender #3613

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80179f1
docs: add link to PollSender
zaharidichev Mar 12, 2021
a9b9c62
feedback
zaharidichev Mar 12, 2021
6914ae4
move to struct
zaharidichev Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tokio/src/sync/mpsc/bounded.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,8 @@ impl<T> Sender<T> {
Sender { chan }
}

/// 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`].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like the link to be in the same place in the docs as where I put the similar thing for Semaphore.

///
/// A successful send occurs when it is determined that the other end of the
/// channel has not hung up already. An unsuccessful send would be one where
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we just put /latest/ here instead of concrete version?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link may break if we move it or remove it in future versions of tokio-util.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know, thanks!

///
/// # Examples
///
Expand Down