Skip to content

Commit

Permalink
Adjusted docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
seanlaw committed Jun 15, 2020
1 parent b87b526 commit 1c81ba3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions stumpy/floss.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,8 +356,8 @@ class floss(object):
-------
update(t)
Ingress a new data point, `t`, onto the time series, `T`, followed by egressing
a oldest single data point from `T`. Then, update the corrected arc curve (CAC)
and the matrix profile.
the oldest single data point from `T`. Then, update the 1-dimensional corrected
arc curve (CAC_1D) and the matrix profile.
Notes
-----
Expand Down Expand Up @@ -463,7 +463,7 @@ def __init__(
def update(self, t):
"""
Ingress a new data point, `t`, onto the time series, `T`, followed by egressing
a oldest single data point from `T`. Then, update the 1-dimensional corrected
the oldest single data point from `T`. Then, update the 1-dimensional corrected
arc curve (CAC_1D) and the matrix profile.
Parameters
Expand Down
10 changes: 6 additions & 4 deletions stumpy/scrump.py
Original file line number Diff line number Diff line change
Expand Up @@ -612,8 +612,9 @@ class scrump(object):
Methods
-------
update()
Update the matrix profile and matrix profile indices by computing additional
(as defined by `percentage`) new distances that make up the full distance matrix
Update the matrix profile and the matrix profile indices by computing
additional new distances (limited by `percentage`) that make up the full
distance matrix.
Notes
-----
Expand Down Expand Up @@ -747,8 +748,9 @@ def __init__(

def update(self):
"""
Update the matrix profile and matrix profile indices by computing additional
(as defined by `percentage`) new distances that make up the full distance matrix
Update the matrix profile and the matrix profile indices by computing
additional new distances (limited by `percentage`) that make up the full
distance matrix.
"""
if self._chunk <= self._n_chunks:
orders_ranges = _get_orders_ranges(
Expand Down

0 comments on commit 1c81ba3

Please sign in to comment.