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

Clean API making some submodules private #362

Merged
merged 13 commits into from
Feb 28, 2023
Merged

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Nov 24, 2022

Make the forward, equivalent_sources, gravity_corrections, isostasy and transformations submodules as private ones. This will enforce the usage of public functions and classes allowing developers to refactor private ones without the risk of braking backward compatibility. It also cleans up the list of options available when using autocompletion in IDEs and JupyterLab, helping the discoverability of the functions and classes we have in Harmonica.

Relevant issues/PRs:
Fixes #314

@santisoler santisoler added the maintenance A maintenance task to improve development label Nov 24, 2022
@santisoler santisoler added this to the v0.6.0 milestone Nov 24, 2022
@santisoler
Copy link
Member Author

The io module should also be private, but this is handled by #348. To avoid having to solve conflicts I'm leaving the io untouched here.

@santisoler santisoler changed the title Make some submodules private Clean API making some submodules private Feb 28, 2023
@santisoler santisoler merged commit 5be63ff into main Feb 28, 2023
@santisoler santisoler deleted the make-submodules-private branch February 28, 2023 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance A maintenance task to improve development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enforce non-public subpackages as private modules?
2 participants