Skip to content

Commit

Permalink
Add documentation for the global vars
Browse files Browse the repository at this point in the history
Cherry-picked from #25
Fixes #17
  • Loading branch information
lguerard authored and ehrenfeu committed Nov 12, 2024
1 parent d83b67f commit 89b5191
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/imcflibs/imagej/bdv.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
from ..log import LOG as log

SINGLE = "[Single %s (Select from List)]"
MULTIPLE = "[Multiple %ss (Select from List)] "
"""Option to use to select only one value for the current dimension"""
MULTIPLE = "[Multiple %ss (Select from List)]"
"""Option to use to select specified multiple values for the current dimension"""
RANGE = "[Range of %ss (Specify by Name)]"
"""@private template string"""
"""Option to use to select a range of values for the current dimension"""


class ProcessingOptions(object):
Expand Down Expand Up @@ -477,8 +479,13 @@ def fmt_use_acitt(self):


SINGLE_FILE = "[NO (one %s)]"
"""Option to use if the current dimension is singular (like only one angle)."""
MULTI_SINGLE_FILE = "[YES (all %ss in one file)]"
"""Option to use if the current dimension is plural (like multiple angles)
contained in a single file."""
MULTI_MULTI_FILE = "[YES (one file per %s)]"
"""Option to use if the current dimension is plural (like multiple angles)
contained in multiple files."""


class DefinitionOptions(object):
Expand Down

0 comments on commit 89b5191

Please sign in to comment.