Formatting

Author: Bromeon

godot-core/src/registry/signal/typed_signal.rs

@@ -5,17 +5,17 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+use std::borrow::Cow;
+use std::marker::PhantomData;
+use std::ops::DerefMut;
+
 use super::{make_callable_name, make_godot_fn, ConnectBuilder, ConnectHandle, SignalObject};
 use crate::builtin::{Callable, Variant};
 use crate::classes::object::ConnectFlags;
 use crate::meta;
 use crate::meta::{InParamTuple, ObjectToOwned, UniformObjectDeref};
 use crate::obj::{Gd, GodotClass, WithSignals};
 use crate::registry::signal::signal_receiver::{IndirectSignalReceiver, SignalReceiver};
-use std::borrow::Cow;
-use std::marker::PhantomData;
-use std::ops::DerefMut;
-// ----------------------------------------------------------------------------------------------------------------------------------------------
 
 /// Type-safe version of a Godot signal.
 ///
@@ -205,38 +205,36 @@ impl<C: WithSignals, Ps: InParamTuple + 'static> TypedSignal<'_, C, Ps> {
     /// # #[derive(GodotClass)]
     /// # #[class(init, base=Node)]
     /// # pub struct Player {
-    /// #     health_ui: OnEditor<Gd<HealthUI>>,
+    /// #     ui: OnEditor<Gd<HealthUi>>,
     /// #     base: Base<Node>,
     /// # }
     /// # #[derive(GodotClass)]
     /// # #[class(init, base=Node2D)]
-    /// # pub struct HealthUI {
+    /// # pub struct HealthUi {
     /// #     base: Base<Node2D>,
     /// # }
-    /// # #[godot_api]
-    /// # impl Player {
-    /// #     #[signal]
-    /// #     fn health_changed(health: i32);
-    /// # }
-    ///  impl Player {
-    ///      fn change_health_anim(&mut self, health: i32) {
-    ///         // Change animation based on health
-    ///      }
-    ///  }
-    ///  impl HealthUI {
-    ///      fn on_health_changed(&mut self, health: i32) {
-    ///         // Change healthbar UI based on health
-    ///      }
-    ///  }
+    /// #[godot_api]
+    /// impl Player {
+    ///     #[signal]
+    ///     fn health_changed(health: i32);
+    ///
+    ///     fn change_health_anim(&mut self, health: i32) { /* ... */ }
+    /// }
+    /// impl HealthUi {
+    ///     fn on_health_changed(&mut self, health: i32) { /* ... */ }
+    /// }
     /// #[godot_api]
     /// impl INode for Player {
     ///     fn ready(&mut self) {
-    ///         self.signals() // Connect to self
+    ///         // Connect to this object.
+    ///         self.signals()
     ///             .health_changed()
     ///             .connect_self(Self::change_health_anim);
-    ///         self.signals() // Connect to other object (health_ui is OnEditor<Gd<HealthUI>>)
+    ///
+    ///         // Connect to other object, where ui: OnEditor<Gd<HealthUi>>.
+    ///         self.signals()
     ///             .health_changed()
-    ///             .connect_self(|s, amount| s.health_ui.bind_mut().on_health_changed(amount));
+    ///             .connect_self(|this, amount| this.ui.bind_mut().on_health_changed(amount));
     ///     }
     /// }
     /// ```
@@ -295,11 +293,14 @@ impl<C: WithSignals, Ps: InParamTuple + 'static> TypedSignal<'_, C, Ps> {
     /// #[godot_api]
     /// impl IControl for Tool {
     ///     fn ready(&mut self) {
-    ///         self.button // Connect from other to self
+    ///         // Connect from other to self.
+    ///         self.button
     ///             .signals()
     ///             .pressed()
     ///             .connect_other(self, Self::execute_tool);
-    ///         self.button // Connect from other to other (other_tool is OnEditor<Gd<OtherTool>>)
+    ///
+    ///         // Connect from other to other, where other_tool: OnEditor<Gd<OtherTool>>.
+    ///         self.button
     ///             .signals()
     ///             .pressed()
     ///             .connect_other(&*self.other_tool, |tool| tool.set_tool_enabled(false));