-
Notifications
You must be signed in to change notification settings - Fork 36
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.
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
Decide which modules should define __all__ #876
Comments
In theory we should define |
I would consider publicly visible modules to also be part of the public API. They may not be how we most frequently interact with packages, but there are many packages that expose functionality that way for a variety of reasons (even synced_collections does this). So things like signac.sync and signac.diff are part of the API too I would say. |
While refactoring I noticed that we define
__all__
in some modules that are not__init__.py
files representing a package. Is that something that we want to do or care about very much? I would be fine relying solely on underscore prefixes in all modules that are not packages and only implementing__all__
for package files, but I don't feel strongly about this. I just wanted to raise the question for consistency's sake.The text was updated successfully, but these errors were encountered: