Skip to content

Commit 614b08f

Browse files
committed
Updated docstrings
1 parent b804512 commit 614b08f

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

stumpy/core.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2117,8 +2117,9 @@ def _preprocess(T, copy=True):
21172117
Time series or sequence
21182118
21192119
copy : bool, default True
2120-
A boolean value that indicates whether the process should be done on
2121-
input `T` (False) or its copy (True).
2120+
A boolean value that indicates whether the process should be performed on
2121+
input array `T` (False) or its copy (True). If `T` is a dataframe, then the
2122+
data is always copied into a brand new array.
21222123
21232124
Returns
21242125
-------
@@ -2173,8 +2174,9 @@ def preprocess(
21732174
Window size
21742175
21752176
copy : bool, default True
2176-
A boolean value that indicates whether the process should be done on
2177-
input `T` (False) or its copy (True).
2177+
A boolean value that indicates whether the process should be performed on
2178+
input array `T` (False) or its copy (True). If `T` is a dataframe, then the
2179+
data is always copied into a brand new array.
21782180
21792181
M_T : numpy.ndarray, default None
21802182
Rolling mean
@@ -2236,8 +2238,9 @@ def preprocess_non_normalized(T, m, copy=True):
22362238
Window size
22372239
22382240
copy : bool, default True
2239-
A boolean value that indicates whether the process should be done on
2240-
input `T` (False) or its copy (True).
2241+
A boolean value that indicates whether the process should be performed on
2242+
input array `T` (False) or its copy (True). If `T` is a dataframe, then the
2243+
data is always copied into a brand new array.
22412244
22422245
Returns
22432246
-------
@@ -2296,8 +2299,9 @@ def preprocess_diagonal(
22962299
corresponding value set to False in this boolean array.
22972300
22982301
copy : bool, default True
2299-
A boolean value that indicates whether the process should be done on
2300-
input `T` (False) or its copy (True).
2302+
A boolean value that indicates whether the process should be performed on
2303+
input array `T` (False) or its copy (True). If `T` is a dataframe, then the
2304+
data is always copied into a brand new array.
23012305
23022306
Returns
23032307
-------

0 commit comments

Comments
 (0)