Hio koodidokumentaatiota

src/correlation_match.rs

@@ -62,7 +62,7 @@ impl CorrelationMatch {
     /// the period of the signal is also returned as the second item in the tuple. This can be used
     /// to compute the fundamental frequency of the signal.
     ///
-    /// All arrays must be less than the maximum size given on `new`.
+    /// No array should exceed the maximum size given on `new`.
     pub fn compute(&mut self, a: &[Num], b: &[Num], w: &[Num]) -> (Num, Option<Num>) {
         assert!(a.len() <= self.max_size);
         assert!(b.len() <= a.len());

src/display.rs

@@ -83,7 +83,9 @@ impl DisplayBuffer {
     ///
     /// The `memory_decay` and `period_decay` parameters determine the decay coefficient of the
     /// memory buffer, and the interval average respectively:  
-    /// `average = coeff * new + (1. - coeff) * average;`  
+    /// ```none
+    /// average = coeff * new + (1. - coeff) * average;
+    /// ```
     /// Set to `1.0` to bypass smoothing.
     ///
     /// [`update_display`](Self::update_display) should be called separately to update the display buffer.