Added minor note on missing mmatch function

TDAmeritrade · Nov 3, 2024 · 3b28371 · 3b28371
1 parent 3cb836b
commit 3b28371
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -34,6 +34,8 @@ Have A Question?
     stumpy.motifs
     stumpy.match
     stumpy.mmotifs
+    stumpy.mmatch
+    stumpy.mmatch
     stumpy.snippets
     stumpy.stimp
     stumpy.stimped
@@ -152,6 +154,11 @@ mmotifs
 
 .. autofunction:: stumpy.mmotifs
 
+mmatch
+======
+
+This function does not exist. See the :func:`stumpy.match` function, which natively supports multi-dimensional time series inputs.
+
 snippets
 ========
 

diff --git a/stumpy/motifs.py b/stumpy/motifs.py
@@ -414,13 +414,13 @@ def match(
     Find all matches of a query ``Q`` in a time series ``T``
 
     The indices of subsequences whose distances to ``Q`` are less than or equal to
-    ``max_distance``, sorted by distance (lowest to highest). Around each occurrence an
+    ``max_distance``, sorted by distance (lowest to highest). Around each occurrence, an
     exclusion zone is applied before searching for the next.
 
     Parameters
     ----------
     Q : numpy.ndarray
-        The query sequence. It doesn't have to be a subsequence of ``T``.
+        The query sequence. ``Q`` does not have to be a subsequence of ``T``.
 
     T : numpy.ndarray
         The time series of interest.