Merge pull request #54 from /issues/17

Remove docstrings for internal globals

Author: ehrenfeu

src/imcflibs/imagej/bdv.py

@@ -21,15 +21,22 @@
 from .. import pathtools
 from ..log import LOG as log
 
+
+# internal template strings used in string formatting (note: the `"""@private"""`
+# pseudo-decorator is there to instruct [pdoc] to omit those variables when generating
+# API documentation):
 SINGLE = "[Single %s (Select from List)]"
-"""Template string to use to select only one value for the current dimension."""
+"""@private"""
 MULTIPLE = "[Multiple %ss (Select from List)]"
-"""Template string to use to select specified multiple values for the current
-dimension."""
+"""@private"""
 RANGE = "[Range of %ss (Specify by Name)]"
-"""Template string to use to select a range of values for the current
-dimension."""
-
+"""@private"""
+SINGLE_FILE = "[NO (one %s)]"
+"""@private"""
+MULTI_SINGLE_FILE = "[YES (all %ss in one file)]"
+"""@private"""
+MULTI_MULTI_FILE = "[YES (one file per %s)]"
+"""@private"""
 
 class ProcessingOptions(object):
     """Helper to store processing options and generate parameter strings.
@@ -513,17 +520,6 @@ def fmt_use_acitt(self):
         return parameter_string + " "
 
 
-SINGLE_FILE = "[NO (one %s)]"
-"""Template string to use if the current dimension is singular (like only one
-angle)."""
-MULTI_SINGLE_FILE = "[YES (all %ss in one file)]"
-"""Template string to use if the current dimension is plural (like multiple
-angles) contained in a single file."""
-MULTI_MULTI_FILE = "[YES (one file per %s)]"
-"""Template string to use if the current dimension is plural (like multiple
-angles) contained in multiple files."""
-
-
 class DefinitionOptions(object):
     """Helper to store definition options and generate parameters strings.