Skip to content

Commit afbf8c8

Browse files
jofasDarksonn
andauthored
Future proofed exception paragraph in runtime compatibility section
Co-authored-by: Alice Ryhl <[email protected]>
1 parent d8dee34 commit afbf8c8

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

tokio/src/sync/mod.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -442,10 +442,9 @@
442442
//! [cooperative scheduling](crate::task#cooperative-scheduling) to avoid
443443
//! starvation. This feature does not apply when used from non-Tokio runtimes.
444444
//!
445-
//! The only exception to runtime compatibility is the
446-
//! [`mpsc::Sender::send_timeout`] method, which can't be called from non-Tokio
447-
//! runtimes. However, [`Senders`](mpsc::Sender) can still be moved between
448-
//! different instances of the Tokio runtime.
445+
//! As an exception, methods ending in `_timeout` are not runtime agnostic
446+
//! because they require access to the Tokio timer. See the documentation of
447+
//! each `*_timeout` method for more information on its use.
449448
450449
cfg_sync! {
451450
/// Named future types.

0 commit comments

Comments
 (0)