DOC: Improve coarsen docstring with detailed reduction requirements#12236
Open
VedantMadane wants to merge 1 commit intodask:mainfrom
Open
DOC: Improve coarsen docstring with detailed reduction requirements#12236VedantMadane wants to merge 1 commit intodask:mainfrom
VedantMadane wants to merge 1 commit intodask:mainfrom
Conversation
Contributor
Unit Test ResultsSee test report for an extended history of previous test failures. This is useful for diagnosing flaky tests. 21 files ±0 21 suites ±0 5h 13m 31s ⏱️ + 8m 50s For more details on these failures, see this check. Results for commit 979a2a7. ± Comparison against base commit e5a9087. ♻️ This comment has been updated with latest results. |
Clarify the requirements for the reduction function parameter: must accept an array as the first argument, must accept an axis keyword argument with a tuple of axes, must return an array of the same type. Also document trim_excess, kwargs, and return value. Closes dask#9825
VedantMadane
force-pushed
the
docs-coarsen-docstring
branch
from
e9c4423 to
979a2a7
Compare
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
1 participant
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.
Summary
Improves the docstring for
dask.array.coarsenby providing detailed documentation of thereductionfunction requirements.Changes
axiskeyword argument with a tuple of integer axestrim_excessparameter**kwargsare passed to the reduction functionReturnssectionMotivation
As noted in the issue, the original docstring only said 'Function like np.sum, np.mean, etc...' which doesn't clearly explain what properties a reduction function needs to have.
Closes #9825