Fix docstring lint error

Macchina-CLI · Feb 1, 2025 · ef854b5 · ef854b5
1 parent 590cb17
commit ef854b5
Showing 1 changed file with 5 additions and 8 deletions.
diff --git a/src/traits.rs b/src/traits.rs
@@ -568,16 +568,13 @@ 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.
+    /// 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.
+    ///     - If `_shorthand` is `ShellFormat::Relative` the basename of the shell will be returned,
+    ///     _e.g._ bash, zsh, etc.
 
-    _e.g._ bash, zsh, etc.
-
-    - If `_shorthand` is `ShellFormat::Absolute` the absolute path of the shell will be returned.
-    */
+    /// - If `_shorthand` is `ShellFormat::Absolute` the absolute path of the shell will be returned.
 
     fn shell(&self, _shorthand: ShellFormat, kind: ShellKind) -> Result<String, ReadoutError>;