Skip to content

Commit

Permalink
docs: clarify documentation of sync module
Browse files Browse the repository at this point in the history
Based on feedback from customers, adding a clearer and top-line comment about runtime-agnosticism for the sync module.
  • Loading branch information
rcoh committed Nov 5, 2024
1 parent 8897885 commit 3eda51a
Showing 1 changed file with 7 additions and 0 deletions.
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

0 comments on commit 3eda51a

Please sign in to comment.