Fix incorrect parameter name in cumulative() docstrings#11425
Open
Sreekant13 wants to merge 1 commit into
Open
Fix incorrect parameter name in cumulative() docstrings#11425Sreekant13 wants to merge 1 commit into
Sreekant13 wants to merge 1 commit into
Conversation
Author
|
Heads-up: the failing This is a documentation-only change ( |
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.
Description
The docstrings for
DataArray.cumulativeandDataset.cumulativedocument the parameter asdims, but the actual signature parameter isdim. As a result, callingobj.cumulative(dims=...)raises aTypeErroreven though the docs showdims. This correctsdims→dimin both Parameters sections to match the signature. Documentation-only change; no behavior change.Checklist
whats-new.rstapi.rst(Docstring-only correction — no tests, whats-new, or api.rst entry needed.)
AI Disclosure
Tools: Claude (Claude Code) was used to help identify the docstring/signature mismatch. I reviewed the change against the
cumulativesignatures in bothdataarray.pyanddataset.py, confirmeddimis the correct parameter name, and take full responsibility for the change.