From 862fde719e9e90f54ff32a5780c4caf07775e81b Mon Sep 17 00:00:00 2001 From: Niko Ehrenfeuchter Date: Tue, 25 Mar 2025 17:24:34 +0100 Subject: [PATCH] Remove docstrings for internal globals As requested in #17, they are not intended to be used directly (i.e. imported into code elsewhere) and therefore should be omitted in the generated API documentation. --- src/imcflibs/imagej/bdv.py | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/src/imcflibs/imagej/bdv.py b/src/imcflibs/imagej/bdv.py index e5a67498..b13779d5 100644 --- a/src/imcflibs/imagej/bdv.py +++ b/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.