Added documentation for the actions of the Reducer#68
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive Google-style docstrings to the public functions and the Stats class in the medunda.actions subpackage, and introduces a new Sphinx documentation page that auto-renders these docstrings.
Changes:
- Replaced short/missing docstrings with detailed ones across all action modules (describing semantics, args, returns, raises, and behavior for masked cells/edge cases).
- Added
docs/source/actions.mdwithautofunction/autoclassdirectives for each action. - Registered the new page in the documentation toctree (
docs/source/index.md).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/medunda/actions/integration.py |
Added docstring for compute_integral. |
src/medunda/actions/integrate_between_layers.py |
Expanded docstring for integrate_between_layers. |
src/medunda/actions/extract_surface.py |
Added docstring for extract_surface. |
src/medunda/actions/extract_layer.py |
Expanded docstring for extract_layer. |
src/medunda/actions/extract_bottom.py |
Added docstring for extract_bottom. |
src/medunda/actions/compute_average.py |
Expanded docstring for compute_average covering depth/space/time axes. |
src/medunda/actions/climatology.py |
Added detailed docstring for climatology covering monthly/daily source cases. |
src/medunda/actions/calculate_stats.py |
Added docstrings to Stats class, its methods, and the calculate_stats function. |
src/medunda/actions/average_between_layers.py |
Expanded docstring for average_between_layers. |
docs/source/actions.md |
New documentation page rendering action APIs via autodoc. |
docs/source/index.md |
Added actions entry to the toctree. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.