Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Undocumented "global" vars #17

Open
ehrenfeu opened this issue Aug 12, 2024 · 0 comments
Open

Undocumented "global" vars #17

ehrenfeu opened this issue Aug 12, 2024 · 0 comments

Comments

@ehrenfeu
Copy link
Member

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ehrenfeu