Skip to content

Commit 1860cfb

Browse files
committed
Added note to docstring
1 parent 795af28 commit 1860cfb

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

stumpy/core.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4525,6 +4525,22 @@ def check_self_join(ignore_trivial):
45254525
Returns
45264526
-------
45274527
None
4528+
4529+
Notes
4530+
-----
4531+
These warnings may be supressed by using a context manager
4532+
```
4533+
import stumpy
4534+
import numpy as np
4535+
import warnings
4536+
4537+
T = np.random.rand(10_000)
4538+
m = 50
4539+
with warnings.catch_warnings():
4540+
warnings.filterwarnings("ignore", message="`ignore_trivial` cannot be `False`")
4541+
for _ in range(5):
4542+
stumpy.stump(T, m, ignore_trivial=False)
4543+
```
45284544
"""
45294545
if not ignore_trivial:
45304546
msg = "`ignore_trivial` cannot be `False` for a self-join and "

0 commit comments

Comments
 (0)