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

fix the docstrings for group operations

parent 8799522b
No related branches found
No related tags found
3 merge requests!685Release 2.4,!684Release 2.4,!639fix the docstrings for group operations
Pipeline #154562 passed with stages
in 5 minutes and 36 seconds
......@@ -556,18 +556,21 @@ class FlagtoolsMixin:
Parameters
----------
field : str
Name of the field to check for flags. 'field' needs to present in all
objects in 'qcs'.
field:
Name of the field to check for flags. ``field`` needs to present in all SaQC objects in ``group``.
group:
A collection of ``SaQC`` objects to check for flags:
qcs : list of SaQC
A list of SaQC objects to check for flags.
1. If given as a list of ``SaQC`` objects, the variable named ``field`` is checked for flags.
2. If given as dictionary the keys represent ``SaQC`` objects and the value one or more
variables of the respective object to check for flags.
target : str, default none
target:
Name of the field the generated flags will be written to. If None, the result
will be written to 'field',
flag: float, default ``BAD``
flag:
The quality flag to set.
Returns
......@@ -605,18 +608,21 @@ class FlagtoolsMixin:
Parameters
----------
field : str
Name of the field to check for flags. 'field' needs to present in all
objects in 'qcs'.
field:
Name of the field to check for flags. ``field`` needs to present in all SaQC objects in ``group``.
group:
A collection of ``SaQC`` objects to check for flags:
qcs : list of SaQC
A list of SaQC objects to check for flags.
1. If given as a list of ``SaQC`` objects, the variable named ``field`` is checked for flags.
2. If given as dictionary the keys represent ``SaQC`` objects and the value one or more
variables of the respective object to check for flags.
target : str, default none
target:
Name of the field the generated flags will be written to. If None, the result
will be written to 'field',
flag: float, default ``BAD``
flag:
The quality flag to set.
Returns
......
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