Skip to content

Commit 8157954

Browse files
committed
List fixed sets of valid values
As described in https://numpydoc.readthedocs.io/en/latest/format.html#parameters
1 parent adbce1d commit 8157954

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

src/imcflibs/imagej/bdv.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -754,10 +754,12 @@ def get_processing_settings(dimension, selection, value, range_end):
754754
755755
Parameters
756756
----------
757-
dimension : str
758-
"angle", "channel", "illumination", "tile" or "timepoint"
759-
selection : str
760-
"single", "multiple", or "range"
757+
dimension : {`angle`, `channel`, `illumination`, `tile`, `timepoint`}
758+
The dimension selection to use.
759+
selection : {`single`, `multiple`, `range`}
760+
The *selector* name ("processing mode"), used to derive how the
761+
generated string needs to be assembled according to the given dimension
762+
and value / range settings.
761763
value : str, int, list of int or list of str
762764
Contains the list of input dimensions, the first input dimension of a range or a single channel
763765
range_end : int or None

0 commit comments

Comments
 (0)