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

Segregate public and private interfaces #2278

Open
ktbarrett opened this issue Dec 9, 2020 · 1 comment
Open

Segregate public and private interfaces #2278

ktbarrett opened this issue Dec 9, 2020 · 1 comment
Labels
type:cleanup cleanup or refactoring on code, documentation, or other areas
Milestone
2.0

Comments

@ktbarrett
Copy link
Member

In Python, the use of methods and attributes starting with a single underscore (_method()) are used to communicate that method or attribute is a private implementation detail and should not be used by the user. Sphinx, Python linters, Python REPLs, and more respect this convention. However, the code in this repo does not. The use of non-underscore methods and attributes on what are clearly private interfaces is rampant. During the 2.0 development phase this should be cleaned up.
@ktbarrett ktbarrett added the type:cleanup cleanup or refactoring on code, documentation, or other areas label Dec 9, 2020
@ktbarrett ktbarrett added this to the 2.0 milestone Dec 9, 2020
@alexforencich
Copy link
Contributor

And the other way around as well - for example cocotb.utils._get_simulator_precision() maybe shouldn't start with an underscore.

@ktbarrett ktbarrett mentioned this issue Jan 9, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:cleanup cleanup or refactoring on code, documentation, or other areas
Projects
None yet
Milestone
2.0
Development

No branches or pull requests
2 participants
@alexforencich @ktbarrett