Project-MONAI / Project-MONAI/monai-deploy-app-sdk

Add __all__ variable to all core modules

Open
#118 0 comments 0 reactions 1 assignee View on GitHub

@gigony is already working on this.

Since Sep 13, 2021.

architectural story
Dominant language
Python
Stars
138
Forks
70
PR merge metrics
No merged PRs in 30d

Description

Defining __all__ in each module helps IDE to find available (public) methods/variables.

Need to add __all__ to all public modules.

Reference


So, what does all actually effect?

  • It tells the readers of the source code — be it humans or automated tools — what’s the conventional public API exposed by the module.
  • It lists names to import when performing the so-called wild import: from module import *.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.