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

Document cancelation safety for watch::Receiver::wait_for #7021

Open
tthebst opened this issue Dec 6, 2024 · 0 comments
Open

Document cancelation safety for watch::Receiver::wait_for #7021

tthebst opened this issue Dec 6, 2024 · 0 comments
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. E-help-wanted Call for participation: Help is requested to fix this issue. M-sync Module: tokio/sync T-docs Topic: documentation

Comments

@tthebst
Copy link
Contributor

tthebst commented Dec 6, 2024

Version
1.42

Description
Documentation does not comment on the cancellation safety for watch::Receiver::wait_for
@tthebst tthebst added A-tokio Area: The main tokio crate C-bug Category: This is a bug. labels Dec 6, 2024
@Darksonn Darksonn added T-docs Topic: documentation M-sync Module: tokio/sync E-help-wanted Call for participation: Help is requested to fix this issue. labels Dec 6, 2024
cip999 added a commit to cip999/tokio that referenced this issue Dec 15, 2024
@cip999
Extend documentation for watch::Receiver<_>::wait_for
7000f08 
- The "Cancel safety" section was missing, as reported in tokio-rs#7021.
- Add the "Panics" section since technically the method can panic.
- Change the doctest to mimic the one for `changed` (also I find the
current version slightly more confusing than it should be).
cip999 added a commit to cip999/tokio that referenced this issue Dec 15, 2024
@cip999
sync: extend documentation for watch::Receiver<_>::wait_for
6569d15 
- The "Cancel safety" section was missing, as reported in tokio-rs#7021.
- Add the "Panics" section since technically the method can panic.
- Change the doctest to mimic the one for `changed` (also I find the
current version slightly more confusing than it should be).

Fixes: tokio-rs#7021
cip999 added a commit to cip999/tokio that referenced this issue Dec 15, 2024
@cip999
sync: extend documentation for watch::Receiver::wait_for
8cf44a2 
- The "Cancel safety" section was missing, as reported in tokio-rs#7021.
- Add the "Panics" section since technically the method can panic.
- Change the doctest to mimic the one for `changed` (also I find the
current version slightly more confusing than it should be).

Fixes: tokio-rs#7021
cip999 added a commit to cip999/tokio that referenced this issue Dec 15, 2024
@cip999
sync: extend documentation for watch::Receiver::wait_for
ff7025f 
- The "Cancel safety" section was missing, as reported in tokio-rs#7021.
- Add the "Panics" section since technically the method can panic.
- Change the doctest to mimic the one for `changed` (also I find the
current version slightly more confusing than it should be).

Fixes: tokio-rs#7021
@cip999 cip999 mentioned this issue Dec 15, 2024
Open
cip999 added a commit to cip999/tokio that referenced this issue Dec 16, 2024
@cip999
sync: extend documentation for watch::Receiver::wait_for
3c53b56 
- The "Cancel safety" section was missing, as reported in tokio-rs#7021.
- Add the "Panics" section since technically the method can panic.
- Change the doctest to mimic the one for `changed` (also I find the
current version slightly more confusing than it should be).

Fixes: tokio-rs#7021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. E-help-wanted Call for participation: Help is requested to fix this issue. M-sync Module: tokio/sync T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Darksonn @tthebst