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

Move the CheckerBoard class to verde.synthetic #353

Merged
merged 4 commits into from Dec 23, 2021
Merged

Move the CheckerBoard class to verde.synthetic #353

merged 4 commits into from Dec 23, 2021

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Dec 23, 2021

Create a new module verde.synthetic to house the CheckerBoard class. The module is imported in __init__.py and a version of CheckerBoard is maintained in verde.datasets that issues a warning when used.

Fixes #349

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.

@leouieda leouieda marked this pull request as draft December 23, 2021 15:01
@leouieda leouieda marked this pull request as ready for review December 23, 2021 15:42
@leouieda leouieda merged commit fbce3ee into main Dec 23, 2021
@leouieda leouieda deleted the checkerboard branch December 23, 2021 15:43
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.

Move the CheckerBoard class to verde.synthetic
1 participant