🐛 Fixed Docs

Author: nwrenger

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "console-utils"
-version = "1.1.8"
+version = "1.1.9"
 edition = "2021"
 authors = ["Nils Wrenger <[email protected]>"]
 description = "Cli input utilities."

Cargo.toml

@@ -186,17 +186,13 @@ pub enum SpinnerType {
 }
 
 impl SpinnerType {
-    /// Converts the spinner type to a vector of frames.
-    ///
-    /// # Returns
-    ///
-    /// Returns a vector of strings representing frames for the spinner, gives back the following variants:
-    ///     - `SpinnerType::Standard`: Standard spinner with characters / - \ |.
-    ///     - `SpinnerType::Dots`: Spinner with dots . .. ... .....
-    ///     - `SpinnerType::Box`: Spinner with box characters ▌ ▀ ▐ ▄.
-    ///     - `SpinnerType::Flip`: Spinner with flip characters _ _ _ - \ ' ´ - _ _ _.
-    ///     - `SpinnerType::Custom(frames)`: Custom spinner with user-defined frames.
-    fn to_frames(&self) -> Vec<&'static str> {
+    /// Converts the spinner type to a vector of frames, gives back the following variants:
+    ///  - `SpinnerType::Standard`: Standard spinner with characters / - \ |.
+    ///  - `SpinnerType::Dots`: Spinner with dots . .. ... .....
+    ///  - `SpinnerType::Box`: Spinner with box characters ▌ ▀ ▐ ▄.
+    ///  - `SpinnerType::Flip`: Spinner with flip characters _ _ _ - \ ' ´ - _ _ _.
+    ///  - `SpinnerType::Custom(frames)`: Custom spinner with user-defined frames.
+    pub fn to_frames(&self) -> Vec<&'static str> {
         match self {
             SpinnerType::Standard => vec!["/", "-", "\\", "|"],
             SpinnerType::Dots => vec![".", "..", "...", "....", "...", ".."],

src/lib.rs

@@ -28,8 +28,8 @@ fn test_select() {
 #[test]
 fn test_spinner() {
     // Give the fn the needed time and SpinnerType
-    spinner(4.2, SpinnerType::Standard);
+    spinner(1.0, SpinnerType::Standard);
 
     // Custom Spinner
-    spinner(4.2, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]))
+    spinner(1.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]))
 }