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.

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

[BUG] Properly define public api #76

Closed
raphaelreinauer opened this issue May 5, 2022 · 1 comment
Closed

[BUG] Properly define public api #76

raphaelreinauer opened this issue May 5, 2022 · 1 comment
Assignees
Labels
bug Something isn't working mid priority The issue is to be solved when possible, as this is a relevant addition to the library

Comments

@raphaelreinauer
Copy link
Collaborator

raphaelreinauer commented May 5, 2022

According to PEP8:

To better support introspection, modules should explicitly declare the names in their public API using the all attribute. Setting all to an empty list indicates that the module has no public API.

https://peps.python.org/pep-0008/#public-and-internal-interfaces

E.g.

'_inner_refactor_scalars', # This should be here

The _inner_refactor_scalars method should not be in the all
Maybe there are more issues like that, it's the only one I encountered.

@raphaelreinauer raphaelreinauer added the bug Something isn't working label May 5, 2022
@matteocao matteocao added this to the Giotto-deep release milestone May 8, 2022
@matteocao matteocao added the mid priority The issue is to be solved when possible, as this is a relevant addition to the library label May 8, 2022
@matteocao matteocao self-assigned this May 17, 2022
matteocao pushed a commit that referenced this issue Jun 2, 2022
@matteocao
Copy link
Contributor

I just went though all the __init__ files and found also this:

'_benchmarking_param',

I corrected all of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working mid priority The issue is to be solved when possible, as this is a relevant addition to the library
Projects
None yet
Development

No branches or pull requests

2 participants