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

AsyncFd's methods are missing information about cancel safety #6654

Open
kckeiks opened this issue Jun 24, 2024 · 0 comments · May be fixed by #6662
Open

AsyncFd's methods are missing information about cancel safety #6654

kckeiks opened this issue Jun 24, 2024 · 0 comments · May be fixed by #6662
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-io Module: tokio/io T-docs Topic: documentation

Comments

@kckeiks
Copy link

kckeiks commented Jun 24, 2024

Add documentation for AsyncFd::readable/readable_mut and AsyncFd::writable/writable_mut and anywhere else where it's applicable.

For reference #6652.
@kckeiks kckeiks added A-tokio Area: The main tokio crate C-bug Category: This is a bug. labels Jun 24, 2024
@Darksonn Darksonn added E-help-wanted Call for participation: Help is requested to fix this issue. T-docs Topic: documentation M-io Module: tokio/io labels Jun 24, 2024
howjmay added a commit to howjmay/tokio that referenced this issue Jun 27, 2024
@howjmay
doc: Add Cancel safety description for AsyncFd's methods
4f287b2 
closes tokio-rs#6654
@howjmay howjmay linked a pull request Jun 27, 2024 that will close this issue
Open
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-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: Add Cancel safety description for AsyncFd's methods howjmay/tokio
2 participants
@Darksonn @kckeiks