Reformat docstring

Macchina-CLI · Feb 1, 2025 · 953ad7f · 953ad7f
1 parent ef854b5
commit 953ad7f
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/src/traits.rs b/src/traits.rs
@@ -568,13 +568,14 @@ pub trait GeneralReadout {
     /// _e.g._ `kitty`
     fn terminal(&self) -> Result<String, ReadoutError>;
 
-    /// This function should return the currently running shell depending on the `_shorthand` value,
-    /// for example: /bin/bash, /bin/zsh, etc.
-
-    ///     - If `_shorthand` is `ShellFormat::Relative` the basename of the shell will be returned,
-    ///     _e.g._ bash, zsh, etc.
-
-    /// - If `_shorthand` is `ShellFormat::Absolute` the absolute path of the shell will be returned.
+    /// This function should return the currently running shell depending on the `_shorthand`
+    /// value, for example: /bin/bash, /bin/zsh, etc.
+    ///
+    /// - If `_shorthand` is `ShellFormat::Relative` the basename of the shell will be returned,
+    /// _e.g._ bash, zsh, etc.
+    ///
+    /// - If `_shorthand` is `ShellFormat::Absolute` the absolute path of the shell will be
+    /// returned.
 
     fn shell(&self, _shorthand: ShellFormat, kind: ShellKind) -> Result<String, ReadoutError>;