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.

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

docs: clarify documentation of sync module #6955

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions tokio/src/sync/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@
//!
//! [tasks]: crate::task
//!
//! **Note**: All functionality provided in this module is runtime agnostic. It is safe
//! and correct to use these primitives without also using Tokio. Some types may provide additional
//! functionality when used with Tokio runtime (e.g. cooperation with [Task Dumps]), but all
//! documented functionality is runtime-agnostic.
//!
//! [Task Dumps]: crate::runtime::Handle::dump
//!
//! # Message passing
//!
//! The most common form of synchronization in a Tokio program is message
Expand Down
Loading