Improved docs [skip ci]

ankane · Sep 25, 2023 · 40816da · 40816da
1 parent 4a81940
commit 40816da
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/mstl_result.rs b/src/mstl_result.rs
@@ -33,7 +33,7 @@ impl MstlResult {
         strength(self.trend(), self.remainder())
     }
 
-    /// Takes ownership of the components.
+    /// Consumes the result, returning the seasonal components, trend component, and remainder.
     pub fn into_parts(self) -> (Vec<Vec<f32>>, Vec<f32>, Vec<f32>) {
         (self.seasonal, self.trend, self.remainder)
     }

diff --git a/src/stl_result.rs b/src/stl_result.rs
@@ -47,7 +47,7 @@ impl StlResult {
         strength(self.trend(), self.remainder())
     }
 
-    /// Takes ownership of the components.
+    /// Consumes the result, returning the seasonal component, trend component, remainder, and weights.
     pub fn into_parts(self) -> (Vec<f32>, Vec<f32>, Vec<f32>, Vec<f32>) {
         (self.seasonal, self.trend, self.remainder, self.weights)
     }