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.

Sign up for GitHub

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

Jump to bottom

include statistics indices in documentation, cleanup docstrings #1958

Merged
merged 3 commits into from
Oct 16, 2024
Merged

include statistics indices in documentation, cleanup docstrings #1958

merged 3 commits into from
Oct 16, 2024

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Oct 15, 2024 •
edited
Loading

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 the xclim.indices.stats module to the indices documentation
  • Updates the source_suffix entry to be consistent with changes to Sphinx

Does this PR introduce a breaking change?

No.

Other information:

I made some light changes to the docstrings, but there are a lot of violations of numpydoc standard in general throughout the library. Will be opening another PR to address these.

@Zeitsperre Zeitsperre added support Questions and help for users/developers docs Improvements to documenation labels Oct 15, 2024
@Zeitsperre Zeitsperre self-assigned this Oct 15, 2024
SarahG-579462
SarahG-579462 approved these changes Oct 16, 2024
View reviewed changes
Copy link
Contributor

@SarahG-579462 SarahG-579462 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!

@github-actions github-actions bot added the approved Approved for additional tests label Oct 16, 2024
@coveralls
Copy link

Coverage Status

coverage: 89.444% (-0.02%) from 89.462%
when pulling 98039e9 on add-api-docs
into bdd4b18 on main.

@Zeitsperre Zeitsperre merged commit b630a8a into main Oct 16, 2024
28 checks passed
@Zeitsperre Zeitsperre deleted the add-api-docs branch October 16, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SarahG-579462 SarahG-579462 SarahG-579462 approved these changes

@aulemahal aulemahal Awaiting requested review from aulemahal

Assignees

@Zeitsperre Zeitsperre

Labels
approved Approved for additional tests docs Improvements to documenation support Questions and help for users/developers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing from indices docs: xclim.indices.stats, only found in /apidoc
3 participants
@Zeitsperre @coveralls @SarahG-579462