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 f5e9bf9 commit c03338d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions tokio/src/runtime/local_runtime/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ use std::time::Duration;
/// 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 cannot be moved between threads or driven from different threads.
///
/// This runtime is incompatible with LocalSet. You should not attempt to drive a LocalSet within a
/// LocalRuntime.
///
/// Currently, this runtime supports one flavor, which is internally identical to current_thread,
/// save for the aforementioned differences related to spawn_local.
///
/// For more general information on how to use runtimes, see the [module] docs.
///
/// [runtime]: crate::runtime::Runtime
Expand Down

0 comments on commit c03338d

Please sign in to comment.