Skip to content
Snippets Groups Projects
Commit 3edc3308 authored by David Schäfer's avatar David Schäfer
Browse files

fixed docstring

parent 8a355bbe
No related branches found
No related tags found
1 merge request!611docstring changes
Pipeline #146266 failed with stages
in 3 minutes and 41 seconds
This commit is part of merge request !611. Comments created here will be created in the context of that merge request.
......@@ -36,11 +36,11 @@ class NoiseMixin:
**kwargs,
) -> "SaQC":
"""
Flag data chunks of length, ``window``, if:
Flag data chunks of length ``window``, if:
1. they excexceed ``thresh`` with regard to ``func``and
2. all (maybe overlapping) sub-chunks of the data chunks with length ``sub_window``,
`excexceed ``sub_thresh`` with regard to ``func``
exceed ``sub_thresh`` with regard to ``func``
Parameters
----------
......@@ -58,7 +58,7 @@ class NoiseMixin:
sub_window: str, default None,
Window size of sub chunks, that are additionally tested for exceeding ``sub_thresh``
with respect to `func`.
with respect to ``func``.
sub_thresh: float, default None
Threshold. A given sub chunk is flagged, if the return value of ``func` excceeds ``sub_thresh``.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment