DOC: Improve coarsen docstring with detailed reduction requirements#12236
DOC: Improve coarsen docstring with detailed reduction requirements#12236VedantMadane wants to merge 2 commits into
Conversation
Unit Test ResultsSee test report for an extended history of previous test failures. This is useful for diagnosing flaky tests. 20 files ±0 20 suites ±0 5h 28m 7s ⏱️ -57s For more details on these failures, see this check. Results for commit 8946a4a. ± Comparison against base commit ac04b15. ♻️ This comment has been updated with latest results. |
VedantMadane
force-pushed
the
docs-coarsen-docstring
branch
from
e9c4423 to
979a2a7
Compare
|
Hi @dask, I've updated this PR. Could you please take a look when you have a moment? Thank you! |
VedantMadane
force-pushed
the
docs-coarsen-docstring
branch
from
979a2a7 to
9caec31
Compare
|
@jrbourbeau given your comments on the issue that this closes would you have some time to review the PR? My guess from the PR description is that this is vibe-coded, so it would be good to check the docs actually match the functionality here. |
Made-with: Cursor
VedantMadane
force-pushed
the
docs-coarsen-docstring
branch
from
9caec31 to
6f0fd2f
Compare
2 participants
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