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

Strictly define the scope of the public interface of the library #131

Open
adubovik opened this issue Jul 12, 2024 · 0 comments
Open

Strictly define the scope of the public interface of the library #131

adubovik opened this issue Jul 12, 2024 · 0 comments

Comments

@adubovik
Copy link
Collaborator

Currently, pretty much every single module in DIAL SDK is publically available.

E.g. modules utils/*.py may be potentially used by a library user, however, we do not really expect this to happen.

Our expectations should be expressed explicitly in the library code.

The modules/classes/methods which we consider to be private to the library (i.e. pertaining to its implementation details) should be prefixed with underscore, so that they are hidden from the public interface.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant