Skip to content

Commit 1c81ba3

Browse files
committed
Adjusted docstrings
1 parent b87b526 commit 1c81ba3

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

stumpy/floss.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,8 @@ class floss(object):
356356
-------
357357
update(t)
358358
Ingress a new data point, `t`, onto the time series, `T`, followed by egressing
359-
a oldest single data point from `T`. Then, update the corrected arc curve (CAC)
360-
and the matrix profile.
359+
the oldest single data point from `T`. Then, update the 1-dimensional corrected
360+
arc curve (CAC_1D) and the matrix profile.
361361
362362
Notes
363363
-----
@@ -463,7 +463,7 @@ def __init__(
463463
def update(self, t):
464464
"""
465465
Ingress a new data point, `t`, onto the time series, `T`, followed by egressing
466-
a oldest single data point from `T`. Then, update the 1-dimensional corrected
466+
the oldest single data point from `T`. Then, update the 1-dimensional corrected
467467
arc curve (CAC_1D) and the matrix profile.
468468
469469
Parameters

stumpy/scrump.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -612,8 +612,9 @@ class scrump(object):
612612
Methods
613613
-------
614614
update()
615-
Update the matrix profile and matrix profile indices by computing additional
616-
(as defined by `percentage`) new distances that make up the full distance matrix
615+
Update the matrix profile and the matrix profile indices by computing
616+
additional new distances (limited by `percentage`) that make up the full
617+
distance matrix.
617618
618619
Notes
619620
-----
@@ -747,8 +748,9 @@ def __init__(
747748

748749
def update(self):
749750
"""
750-
Update the matrix profile and matrix profile indices by computing additional
751-
(as defined by `percentage`) new distances that make up the full distance matrix
751+
Update the matrix profile and the matrix profile indices by computing
752+
additional new distances (limited by `percentage`) that make up the full
753+
distance matrix.
752754
"""
753755
if self._chunk <= self._n_chunks:
754756
orders_ranges = _get_orders_ranges(

0 commit comments

Comments
 (0)