From 40816da294d2895d24e983f25c3f01b6d8b1f0bf Mon Sep 17 00:00:00 2001
From: Andrew Kane <andrew@ankane.org>
Date: Mon, 25 Sep 2023 00:24:07 -0700
Subject: [PATCH] Improved docs [skip ci]

---
 src/mstl_result.rs | 2 +-
 src/stl_result.rs  | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/mstl_result.rs b/src/mstl_result.rs
index 11589e2..f6533bf 100644
--- 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
index b99666c..173d1df 100644
--- 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)
     }