Skip to content

sync: improve the docs for the errors of mpsc#7722

Merged
martin-g merged 3 commits intotokio-rs:masterfrom
tqwewe:master
Nov 5, 2025
Merged

sync: improve the docs for the errors of mpsc#7722
martin-g merged 3 commits intotokio-rs:masterfrom
tqwewe:master

Conversation

@tqwewe
Copy link
Contributor

@tqwewe tqwewe commented Nov 5, 2025

Standardize and fix code docs for the TrySendError and SendTimeoutError enums.

The TrySendError code docs were changed to match the SendTimeoutError and TryRecvError docs.

@github-actions github-actions bot added the R-loom-sync Run loom sync tests on this PR label Nov 5, 2025
@tqwewe tqwewe marked this pull request as draft November 5, 2025 12:17
@tqwewe tqwewe marked this pull request as ready for review November 5, 2025 12:20
@ADD-SP ADD-SP added T-docs Topic: documentation A-tokio Area: The main tokio crate M-sync Module: tokio/sync and removed R-loom-sync Run loom sync tests on this PR labels Nov 5, 2025
Copy link
Member

@ADD-SP ADD-SP left a comment

Choose a reason for hiding this comment

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

Thanks!

@ADD-SP ADD-SP changed the title docs: fix documentation comments for mpsc error enums sync: improve the docs for the errors of mpsc Nov 5, 2025
@martin-g martin-g enabled auto-merge (squash) November 5, 2025 12:37
@martin-g martin-g merged commit 0671c20 into tokio-rs:master Nov 5, 2025
90 of 91 checks passed
benjaminran pushed a commit to benjaminran/tokio that referenced this pull request Nov 6, 2025
* docs: fix documentation comments for mpsc error enums

* docs: improve code docs for `TryRecvError`

* docs: improve code docs for mpsc `SendError`
Daksh14 pushed a commit to Daksh14/tokio that referenced this pull request Nov 11, 2025
* docs: fix documentation comments for mpsc error enums

* docs: improve code docs for `TryRecvError`

* docs: improve code docs for mpsc `SendError`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-tokio Area: The main tokio crate M-sync Module: tokio/sync T-docs Topic: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants