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

FutureWarning for sdba migration to xsdba #2073

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Feb 11, 2025

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • CHANGELOG.rst has been updated (with summary of main changes)
    • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

  • Adds a FutureWarning emitted on import of xclim.sdba
  • Adds Warning messages to the API docs page and autogenerated documentation.
  • Adds a workflow that posts a warning message on Pull Requests that modify the xclim.sdba module. Without approval, merging is explicitly blocked.

Does this PR introduce a breaking change?

Yes. xclim.sdba is now officially in the process of being deprecated.

Other information:

https://github.com/Ouranosinc/xsdba

@Zeitsperre Zeitsperre requested a review from a team February 11, 2025 22:07
@Zeitsperre Zeitsperre self-assigned this Feb 11, 2025
@github-actions github-actions bot added sdba Issues concerning the sdba submodule. CI Automation and Contiunous Integration docs Improvements to documenation labels Feb 11, 2025
docs/api.rst Outdated Show resolved Hide resolved
@Zeitsperre Zeitsperre requested a review from a team February 13, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Automation and Contiunous Integration docs Improvements to documenation sdba Issues concerning the sdba submodule.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants