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

Clarify what the API is and how it should be used #253

Closed
leouieda opened this issue Aug 23, 2021 · 0 comments · Fixed by #288
Closed

Clarify what the API is and how it should be used #253

leouieda opened this issue Aug 23, 2021 · 0 comments · Fixed by #288
Labels
documentation Improvements or additions to documentation

Comments

@leouieda
Copy link
Member

Description of the desired feature

We use modules only internally and define the public API by importing things in pooch/__init__.py. So everything is accessible from the top level pooch namespace.

This should be clarified in the API page (https://www.fatiando.org/pooch/latest/api/) and instructing users that anything imported from individual modules can be moved/removed at any time.

Are you willing to help implement and maintain this feature? Yes

Related to #252
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Tell users to import from the top-level namespace fatiando/pooch
1 participant
@leouieda