Skip to content

Commit a4e8a66

Browse files
committed
Fixed docstring for match function
1 parent c21f8de commit a4e8a66

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

stumpy/aamp_motifs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,8 @@ def aamp_match(
313313
-------
314314
out : numpy.ndarray
315315
The first column consists of distances of subsequences of `T` whose distances
316-
to `Q` are smaller than `max_distance`, sorted by distance (lowest to highest).
317-
The second column consists of the corresponding indices in `T`.
316+
to `Q` are less than or equal to`max_distance`, sorted by distance (lowest to
317+
highest). The second column consists of the corresponding indices in `T`.
318318
"""
319319
if len(Q.shape) == 1:
320320
Q = Q[np.newaxis, :]

stumpy/motifs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,8 +353,8 @@ def match(
353353
-------
354354
out : numpy.ndarray
355355
The first column consists of distances of subsequences of `T` whose distances
356-
to `Q` are smaller than `max_distance`, sorted by distance (lowest to highest).
357-
The second column consists of the corresponding indices in `T`.
356+
to `Q` are less than or equal to `max_distance`, sorted by distance (lowest to
357+
highest). The second column consists of the corresponding indices in `T`.
358358
359359
See Also
360360
--------

0 commit comments

Comments
 (0)