Merge branch 'docBugs' into 'develop'

doc errors mitigated

See merge request !454

saqc/core/modules/drift.py

@@ -90,3 +90,34 @@ class Drift:
         **kwargs,
     ) -> saqc.SaQC:
         return self._defer("correctOffset", locals())
+
+    @doc(saqc.funcs.drift.flagRegimeAnomaly.__doc__)
+    def flagRegimeAnomaly(
+        self,
+        field: str,
+        cluster_field: str,
+        spread: float,
+        method: LinkageString = "single",
+        metric: Callable[[np.ndarray, np.ndarray], float] = lambda x, y: np.abs(
+            np.nanmean(x) - np.nanmean(y)
+        ),
+        frac: float = 0.5,
+        flag: float = BAD,
+        **kwargs,
+    ) -> saqc.SaQC:
+        return self._defer("flagRegimeAnomaly", locals())
+
+    @doc(saqc.funcs.drift.assignRegimeAnomaly.__doc__)
+    def assignRegimeAnomaly(
+        self,
+        field: str,
+        cluster_field: str,
+        spread: float,
+        method: LinkageString = "single",
+        metric: Callable[[np.ndarray, np.ndarray], float] = lambda x, y: np.abs(
+            np.nanmean(x) - np.nanmean(y)
+        ),
+        frac: float = 0.5,
+        **kwargs,
+    ) -> saqc.SaQC:
+        return self._defer("assignRegimeAnomaly", locals())

saqc/core/modules/tools.py

@@ -34,7 +34,7 @@ class Tools:
         return self._defer("renameField", locals())
 
     @doc(saqc.funcs.tools.selectTime.__doc__)
-    def maskTime(
+    def selectTime(
         self,
         field: str,
         mode: Literal["periodic", "selection_field"],

saqc/funcs/pattern.py

@@ -30,10 +30,10 @@ def flagPatternByWavelet(
     Pattern recognition via wavelets.
 
     The steps are:
-     1. work on chunks returned by a moving window
-     2. each chunk is compared to the given pattern, using the wavelet algorithm as
-        presented in [1]
-     3. if the compared chunk is equal to the given pattern it gets flagged
+    1. work on chunks returned by a moving window
+    2. each chunk is compared to the given pattern, using the wavelet algorithm as
+       presented in [1]
+    3. if the compared chunk is equal to the given pattern it gets flagged
 
     Parameters
     ----------
@@ -199,10 +199,10 @@ def flagPatternByDTW(
     """Pattern Recognition via Dynamic Time Warping.
 
     The steps are:
-     1. work on a moving window
-     2. for each data chunk extracted from each window, a distance to the given pattern
-        is calculated, by the dynamic time warping algorithm [1]
-     3. if the distance is below the threshold, all the data in the window gets flagged
+    1. work on a moving window
+    2. for each data chunk extracted from each window, a distance to the given pattern
+       is calculated, by the dynamic time warping algorithm [1]
+    3. if the distance is below the threshold, all the data in the window gets flagged
 
     Parameters
     ----------

sphinxdoc/funcSummaries/pattern.rst

@@ -11,6 +11,4 @@ pattern
 
 .. autosummary::
 
-   ~SaQC.flagPatternByWavelet
-   ~SaQC.calculateDistanceByDTW
    ~SaQC.flagPatternByDTW

sphinxdoc/getting_started/TutorialCLI.rst

@@ -236,12 +236,12 @@ which gives you separate plots for each call to plot:
 
    * - SM1
      - SM2
-   * - .. image:: ../resources/images/SM1processingResults.png
-          :target: ../resources/images/SM1processingResults.png
+   * - .. image:: ../resources/temp/SM1processingResults.png
+          :target: ../resources/temp/SM1processingResults.png
           :alt:
 
-     - .. image:: ../resources/images/SM2processingResults.png
-          :target: ../resources/images/SM2processingResults.png
+     - .. image:: ../resources/temp/SM2processingResults.png
+          :target: ../resources/temp/SM2processingResults.png
           :alt: