Skip to content

Commit d59c286

Browse files
NimaSarajpoorNimaSarajpoor
authored
Fix description of parameter p in docstring (#565)
1 parent 1e69e3c commit d59c286

14 files changed

Lines changed: 23 additions & 23 deletions

‎stumpy/core.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1355,7 +1355,7 @@ def mass(Q, T, M_T=None, Σ_T=None, normalize=True, p=2.0):
13551355
13561356
p : float, default 2.0
13571357
The p-norm to apply for computing the Minkowski distance. This parameter is
1358-
ignored when `normalize == False`.
1358+
ignored when `normalize == True`.
13591359
13601360
Returns
13611361
-------

‎stumpy/gpu_mpdist.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def gpu_mpdist(
5757
5858
p : float, default 2.0
5959
The p-norm to apply for computing the Minkowski distance. This parameter is
60-
ignored when `normalize == False`.
60+
ignored when `normalize == True`.
6161
6262
Returns
6363
-------

‎stumpy/gpu_ostinato.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def gpu_ostinato(Ts, m, device_id=0, normalize=True, p=2.0):
3838
3939
p : float, default 2.0
4040
The p-norm to apply for computing the Minkowski distance. This parameter is
41-
ignored when `normalize == False`.
41+
ignored when `normalize == True`.
4242
4343
Returns
4444
-------

‎stumpy/gpu_stump.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ def gpu_stump(
412412
413413
p : float, default 2.0
414414
The p-norm to apply for computing the Minkowski distance. This parameter is
415-
ignored when `normalize == False`.
415+
ignored when `normalize == True`.
416416
417417
Returns
418418
-------

‎stumpy/mmotifs.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def mmotifs(
9393
9494
p : float, default 2.0
9595
The p-norm to apply for computing the Minkowski distance. This parameter is
96-
ignored when `normalize == False`.
96+
ignored when `normalize == True`.
9797
9898
Returns
9999
-------

‎stumpy/motifs.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ def motifs(
228228
229229
p : float, default 2.0
230230
The p-norm to apply for computing the Minkowski distance. This parameter is
231-
ignored when `normalize == False`.
231+
ignored when `normalize == True`.
232232
233233
Return
234234
------
@@ -372,7 +372,7 @@ def match(
372372
373373
p : float, default 2.0
374374
The p-norm to apply for computing the Minkowski distance. This parameter is
375-
ignored when `normalize == False`.
375+
ignored when `normalize == True`.
376376
377377
Returns
378378
-------

‎stumpy/mpdist.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ def mpdist(T_A, T_B, m, percentage=0.05, k=None, normalize=True, p=2.0):
324324
325325
p : float, default 2.0
326326
The p-norm to apply for computing the Minkowski distance. This parameter is
327-
ignored when `normalize == False`.
327+
ignored when `normalize == True`.
328328
329329
Returns
330330
-------
@@ -403,7 +403,7 @@ def mpdisted(dask_client, T_A, T_B, m, percentage=0.05, k=None, normalize=True,
403403
404404
p : float, default 2.0
405405
The p-norm to apply for computing the Minkowski distance. This parameter is
406-
ignored when `normalize == False`.
406+
ignored when `normalize == True`.
407407
408408
Returns
409409
-------

‎stumpy/mstump.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ def subspace(
277277
278278
p : float, default 2.0
279279
The p-norm to apply for computing the Minkowski distance. This parameter is
280-
ignored when `normalize == False`.
280+
ignored when `normalize == True`.
281281
282282
Returns
283283
-------
@@ -481,7 +481,7 @@ def mdl(
481481
482482
p : float, default 2.0
483483
The p-norm to apply for computing the Minkowski distance. This parameter is
484-
ignored when `normalize == False`.
484+
ignored when `normalize == True`.
485485
486486
Returns
487487
-------
@@ -670,7 +670,7 @@ def multi_distance_profile(
670670
671671
p : float, default 2.0
672672
The p-norm to apply for computing the Minkowski distance. This parameter is
673-
ignored when `normalize == False`.
673+
ignored when `normalize == True`.
674674
675675
Returns
676676
-------
@@ -1149,7 +1149,7 @@ def mstump(T, m, include=None, discords=False, normalize=True, p=2.0):
11491149
11501150
p : float, default 2.0
11511151
The p-norm to apply for computing the Minkowski distance. This parameter is
1152-
ignored when `normalize == False`.
1152+
ignored when `normalize == True`.
11531153
11541154
Returns
11551155
-------

‎stumpy/ostinato.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ def ostinato(Ts, m, normalize=True, p=2.0):
268268
269269
p : float, default 2.0
270270
The p-norm to apply for computing the Minkowski distance. This parameter is
271-
ignored when `normalize == False`.
271+
ignored when `normalize == True`.
272272
273273
Returns
274274
-------
@@ -365,7 +365,7 @@ def ostinatoed(dask_client, Ts, m, normalize=True, p=2.0):
365365
366366
p : float, default 2.0
367367
The p-norm to apply for computing the Minkowski distance. This parameter is
368-
ignored when `normalize == False`.
368+
ignored when `normalize == True`.
369369
370370
Returns
371371
-------

‎stumpy/scrump.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ def prescrump(T_A, m, T_B=None, s=None, normalize=True, p=2.0):
293293
294294
p : float, default 2.0
295295
The p-norm to apply for computing the Minkowski distance. This parameter is
296-
ignored when `normalize == False`.
296+
ignored when `normalize == True`.
297297
298298
Returns
299299
-------
@@ -391,7 +391,7 @@ class scrump:
391391
392392
p : float, default 2.0
393393
The p-norm to apply for computing the Minkowski distance. This parameter is
394-
ignored when `normalize == False`.
394+
ignored when `normalize == True`.
395395
396396
Attributes
397397
----------
@@ -495,7 +495,7 @@ def __init__(
495495
496496
p : float, default 2.0
497497
The p-norm to apply for computing the Minkowski distance. This parameter is
498-
ignored when `normalize == False`.
498+
ignored when `normalize == True`.
499499
"""
500500
self._ignore_trivial = ignore_trivial
501501

0 commit comments

Comments
 (0)