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

Mark all symbols not supposed to be exposed as private #9

Open
spbnick opened this issue Oct 15, 2020 · 2 comments
Open

Mark all symbols not supposed to be exposed as private #9

spbnick opened this issue Oct 15, 2020 · 2 comments
Labels
good second issue Good for newcomers who're ready to try something harder

Comments

@spbnick
Copy link
Collaborator

spbnick commented Oct 15, 2020

Figure out the correct way for, and mark all symbols not explicitly supposed to be exposed as private to avoid unintended use and unnecessary coupling.

Check Python conventions, and available technical solutions, to mark module-public symbols which are library-private. I.e. symbols which are used by other modules in the library, but are not supposed to be used outside the library.

@spbnick spbnick added this to the v3 milestone Oct 15, 2020
@spbnick spbnick added the good first issue Good for newcomers label Feb 17, 2021
@spbnick spbnick added good second issue Good for newcomers who're ready to try something harder and removed good first issue Good for newcomers labels Oct 13, 2021
@mrbazzan
Copy link
Contributor

mrbazzan commented Nov 2, 2021

@spbnick I'm interested in this issue. Do I need additional information?

@spbnick
Copy link
Collaborator Author

spbnick commented Nov 3, 2021

@mrbazzan, yeaah, this one is not so straightforward, as you would need to figure out which symbols are useful to library users and which are not. However, you can help a lot if you do the research on the ways to implement that.

@spbnick spbnick removed this from the v3 milestone Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good second issue Good for newcomers who're ready to try something harder
Projects
None yet
Development

No branches or pull requests

2 participants