Skip to content

Commit

Permalink
docs: update docstring in core
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmueller committed Nov 25, 2022
1 parent cc4dfac commit e22503a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions shapeout2/pipeline/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,17 @@ def get_datasets(self, filt_index=-1, apply_filter=True):
"""Return all datasets with filters applied
The parameters are passed to :func:`Pipeline.get_dataset`.
Parameters
----------
filt_index: int or None
index of filter; if None, then the plain dataset is returned.
If negative (default), then the last dataset in the pipeline
is returned (all selected filters applied).
apply_filter: bool
whether to call `dataset.apply_filter` in the end;
if set to `False`, only the filtering configuration
of the dataset and its hierarchy parents are updated
"""
kw = {"filt_index": filt_index,
"apply_filter": apply_filter}
Expand Down

0 comments on commit e22503a

Please sign in to comment.