Undocumented "global" vars

[ehrenfeu]

Lines like these ones

python-imcflibs/src/imcflibs/imagej/bdv.py

Lines 453 to 455 in ea1e903

	SINGLE_FILE = "[NO (one %s)]"
	MULTI_SINGLE_FILE = "[YES (all %ss in one file)]"
	MULTI_MULTI_FILE = "[YES (one file per %s)]"

should have:

• either proper "variable docstrings" (usually preferred)
• or be explicitly excluded from the API docs by adding a """@private""" pseudo-docstring (see lines 21 to 24 in the same file)

Pinging @lguerard

[ehrenfeu]

Hum, I think after looking at the rendered API docs I changed my mind once again:

Having the global vars documented doesn't really add value to the API docs, but instead rather clutters them up quite a bit (the module already has a lot of things anyway).

Especially since they're NOT meant to be imported / used in code other than this very module itself (bdv), I think it's preferable to use the """@private""" notation mentioned above to exclude them from the docs.

Here's a screenshot of the docs rendered for 1.5.0.a16:

[ehrenfeu]

The modifications requested in my previous comment should only be done AFTER #39 has been completed and merged!

Added label blocked to this issue.