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

Update sdba documentation #1230

Merged
merged 13 commits into from Jan 10, 2023
Merged

Update sdba documentation #1230

merged 13 commits into from Jan 10, 2023

Conversation

aulemahal
Copy link
Collaborator

@aulemahal aulemahal commented Nov 9, 2022

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • HISTORY.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?

  • Merge of the documentation of the module (xclim/sdba/__init__.py) with the rst (docs/sdba.rst). The former was not appearing in any easy-to-find place.
  • Some cleanup, addition of the Roy et al. citation to the bib file.
  • Addition of a "Other documentation" section that points to the notebooks, but also to some github issues discussing some aspects of SDBA.

Does this PR introduce a breaking change?

No

@github-actions github-actions bot added docs Improvements to documenation sdba Issues concerning the sdba submodule. labels Nov 9, 2022
@huard huard self-requested a review December 13, 2022 15:27
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Outdated Show resolved Hide resolved
docs/sdba.rst Show resolved Hide resolved
docs/sdba.rst Outdated
@@ -83,7 +83,7 @@ Radiation and precipitation

In theory, short wave radiation should be capped when precipitation is not zero, but there is as of yet no mechanism proposed to do that, see :cite:t:`hoffmann_meteorologically_2012`.

Other documentation
Usage examples
===================
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
===================
==============

@Zeitsperre Zeitsperre added the approved Approved for additional tests label Dec 20, 2022
@aulemahal aulemahal merged commit d57ed48 into master Jan 10, 2023
@aulemahal aulemahal deleted the upd-sdba-doc branch January 10, 2023 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Approved for additional tests docs Improvements to documenation sdba Issues concerning the sdba submodule.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants