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 classes Variable, Variables and Datasets #1944

Merged
merged 4 commits into from Dec 10, 2020

Conversation

schlunma
Copy link
Contributor

@schlunma schlunma commented Dec 8, 2020

Deprecate classes Variable, Variables and Datasets.

Closes #1943


Checklist for technical review

  • Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)
  • The pull request has a descriptive title that can be used as a one line summary in the changelog
  • The code is composed of functions of no more than 50 lines and uses meaningful names for variables and follows the style guide
  • Documentation is available
  • Please use yamllint to check that your YAML files do not contain mistakes
  • (Only if really necessary) Add any additional dependencies needed for the diagnostic script to setup.py, esmvaltool/install/R/r_requirements.txt or esmvaltool/install/Julia/Project.toml (depending on the language of your script) and also to package/meta.yaml for conda dependencies (includes Python and others, but not R/Julia). Also check that the license of the dependency you want to add and any of its dependencies are compatible with Apache2.0.

Automated checks pass, status can be seen below the pull request:

  • Circle/CI tests pass. If the tests are failing, click the Details link to find out why.
  • Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.
  • The documentation is building successfully on readthedocs and looks well formatted, click the Details link to see it.

@schlunma schlunma self-assigned this Dec 8, 2020
@schlunma schlunma changed the title Deprecate classes Variable, Variables and Datasets Deprecated classes Variable, Variables and Datasets Dec 8, 2020
Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Looks good, but I realized I made a mistake with the version in which to remove the feature, see also my comment in the issue.

esmvaltool/diag_scripts/shared/_diag.py Outdated Show resolved Hide resolved
esmvaltool/diag_scripts/shared/_diag.py Outdated Show resolved Hide resolved
esmvaltool/diag_scripts/shared/_diag.py Outdated Show resolved Hide resolved
@bouweandela bouweandela changed the title Deprecated classes Variable, Variables and Datasets Deprecate classes Variable, Variables and Datasets Dec 8, 2020
@bouweandela
Copy link
Member

It would probably be good to mention that the feature is deprecated and will be removed in the docstring of the affected classes too, so it becomes visible here: https://docs.esmvaltool.org/en/latest/api/esmvaltool.diag_scripts.shared.html#esmvaltool.diag_scripts.shared.Variable

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Looks good! Tested it and it works as expected.

@schlunma schlunma merged commit 505cd57 into master Dec 10, 2020
6 checks passed
@schlunma schlunma deleted the deprecate_object_oriented_interface branch December 10, 2020 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate classes Variable, Variables, Datasets
2 participants