From 09548c96b045227290d3494ca3fe3863912adfad Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Sun, 29 Oct 2023 18:45:12 +0000 Subject: [PATCH] doc: fix doc references --- actix-rt/src/system.rs | 33 ++++++++++++++++----------------- actix-server/src/builder.rs | 4 +++- 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/actix-rt/src/system.rs b/actix-rt/src/system.rs index 8ff02c83..4c276beb 100644 --- a/actix-rt/src/system.rs +++ b/actix-rt/src/system.rs @@ -203,16 +203,20 @@ impl SystemRunner { .map_err(|err| io::Error::new(io::ErrorKind::Other, err)) } - /// Retrieves a reference to the underlying Actix runtime associated with this SystemRunner instance. + /// Retrieves a reference to the underlying [Actix runtime](crate::Runtime) associated with this + /// `SystemRunner` instance. /// - /// The Actix runtime is responsible for managing the event loop for an Actix system and executing asynchronous tasks. - /// This method provides access to the runtime, allowing direct interaction with its features. + /// The Actix runtime is responsible for managing the event loop for an Actix system and + /// executing asynchronous tasks. This method provides access to the runtime, allowing direct + /// interaction with its features. /// /// In a typical use case, you might need to share the same runtime between different - /// parts of your project. For example, some components might require a [`actix_rt::Runtime`] to spawn tasks on - /// the same runtime. + /// parts of your project. For example, some components might require a [`Runtime`] to spawn + /// tasks on the same runtime. /// - /// # Example + /// Read more in the documentation for [`Runtime`]. + /// + /// # Examples /// /// ``` /// let system_runner = actix_rt::System::new(); @@ -221,19 +225,14 @@ impl SystemRunner { /// // Use the runtime to spawn an async task or perform other operations /// ``` /// - /// Read more in the documentation for [`actix_rt::Runtime`] - /// - /// # Returns - /// - /// An immutable reference to the [`actix_rt::Runtime`] instance associated with this - /// [`actix_rt::SystemRunner`] instance. - /// /// # Note /// - /// While this method provides an immutable reference to the Actix runtime, which is safe to share across threads, - /// be aware that spawning blocking tasks on the Actix runtime could potentially impact system performance. - /// This is because the Actix runtime is responsible for driving the system, - /// and blocking tasks could delay other tasks in the run loop. + /// While this method provides an immutable reference to the Actix runtime, which is safe to + /// share across threads, be aware that spawning blocking tasks on the Actix runtime could + /// potentially impact system performance. This is because the Actix runtime is responsible for + /// driving the system, and blocking tasks could delay other tasks in the run loop. + /// + /// [`Runtime`]: crate::Runtime pub fn runtime(&self) -> &crate::runtime::Runtime { &self.rt } diff --git a/actix-server/src/builder.rs b/actix-server/src/builder.rs index 33da31c5..dcb05d44 100644 --- a/actix-server/src/builder.rs +++ b/actix-server/src/builder.rs @@ -13,7 +13,9 @@ use crate::{ /// Multipath TCP (MPTCP) preference. /// -/// Also see [`ServerBuilder::mptcp()`]. +/// Currently only useful on Linux. +/// +#[cfg_attr(target_os = "linux", doc = "Also see [`ServerBuilder::mptcp()`].")] #[derive(Debug, Clone)] pub enum MpTcp { /// MPTCP will not be used when binding sockets.