Skip to content

Commit

Permalink
cleanup runtime docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Noah-Kennedy committed Oct 2, 2024
1 parent 381ab8b commit f5e9bf9
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions tokio/src/runtime/local_runtime/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ use std::time::Duration;

/// A local Tokio runtime.
///
/// This runtime is identical to a `current_thread` [runtime], save for not being `!Send + !Sync`,
/// and supporting `spawn_local`.
/// This runtime is capable of driving tasks which are not `Send + Sync` without the use of a
/// `LocalSet`, and thus supports `spawn_local` without the need for a LocalSet context.
///
/// This runtime is incompatible with LocalSet. You should not attempt to drive a LocalSet within a
/// LocalRuntime.
///
/// For more general information on how to use runtimes, see the [module] docs.
///
Expand Down

0 comments on commit f5e9bf9

Please sign in to comment.