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

Deprecate the sample datasets #277

Merged
merged 3 commits into from
Dec 23, 2021
Merged

Deprecate the sample datasets #277

merged 3 commits into from
Dec 23, 2021

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Jul 24, 2020

Sample data will be removed in Verde 2.0.0 in favour of using the Ensaio library instead. Add a deprecation warning to all fetching and plotting functions and warnings to the documentation and docstrings.

Fixes #276

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.

@santisoler santisoler requested a review from leouieda July 24, 2020 17:20
@santisoler
Copy link
Member Author

After removing these functions, the dataset module will only contain the synthetic CheckBoard class.
Shouldn't we find a new place for it to live, maybe something like verde/synthetic (as Harmonica has)?

@santisoler
Copy link
Member Author

We should also update the gallery examples to use Rockhound fetch functions instead the ones in verde.datasets

@santisoler santisoler changed the title Add deprecation warnings for datasets WIP Add deprecation warnings for datasets Jul 24, 2020
@santisoler santisoler changed the title WIP Add deprecation warnings for datasets WIP Add deprecation warnings for sample datasets Sep 15, 2020
@leouieda leouieda changed the title WIP Add deprecation warnings for sample datasets Deprecate the sample datasets Dec 23, 2021
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@santisoler I updated this to mention Ensaio instead and will merge it as soon as CI are happy. Thanks for pushing this!

@leouieda
Copy link
Member

leouieda commented Dec 23, 2021

After removing these functions, the dataset module will only contain the synthetic CheckBoard class.
Shouldn't we find a new place for it to live, maybe something like verde/synthetic (as Harmonica has)?

It probably would be better there. We'd need a new PR adding the verde/synthetic.py module with CheckerBoard and import it back in verde.datasets with a DeprecationWarning. See #349

@leouieda leouieda merged commit 10eb69b into main Dec 23, 2021
@leouieda leouieda deleted the deprecate-datasets branch December 23, 2021 13:13
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.

Deprecate datasets module
2 participants