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

Tell users to import from the top-level namespace #288

Merged
merged 1 commit into from
Jan 7, 2022
Merged

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Jan 7, 2022

Add a note to the API docs instructing users to always import from the pooch top-level namespace instead of submodules.

Fixes #253

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Add a note to the API docs instructing users to always import from the
`pooch` top-level namespace instead of submodules.
@leouieda leouieda merged commit 4591852 into main Jan 7, 2022
@leouieda leouieda deleted the api-docs branch January 7, 2022 16:39
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

Successfully merging this pull request may close these issues.

Clarify what the API is and how it should be used
1 participant