docs: add summary lines to 19 reducer operation docstrings#4129
Open
TaiSakuma wants to merge 3 commits into
Open
docs: add summary lines to 19 reducer operation docstrings#4129TaiSakuma wants to merge 3 commits into
TaiSakuma wants to merge 3 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
Member
Author
|
Follow-up per @ikrommyd's review on #4130: the Returns
|
13 tasks
Add a Google-style one-line summary and `Returns:`/`Examples:` section headers to the 19 reducer operations (28 functions, including the nan* variants) in `src/awkward/operations/`: all, any, sum, prod, count, count_nonzero, min, max, argmin, argmax, mean, std, var, moment, corr, covar, ptp, linear_fit, softmax. Follows the pilot in scikit-hep#3946 on `ak.flatten`. Original body text is preserved; only structural edits are applied. Refs scikit-hep#3980. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
…#3980. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…tion. Refs scikit-hep#3980. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
57fe7ba to
77b358f
Compare
|
The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR4129 |
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.
Summary
Rolls the pilot from #3946 out to the 19 operations (28 functions, including the
nan*variants) in the Reducers batch of #3980:all,any,sum,prod,count,count_nonzero,min,max,argmin,argmax,mean,std,var,moment,corr,covar,ptp,linear_fit,softmax.Each docstring now has:
""".Returns:andExamples:section headers (the latter only where examples exist).Original body text is preserved; only structural edits are applied. The summary lines were reviewed against the checklist posted in #3980.
Summary lines
ak.allak.anyak.sumak.nansumak.prodak.nanprodak.countak.count_nonzeroak.minak.nanminak.maxak.nanmaxak.argminak.nanargminak.argmaxak.nanargmaxak.meanak.nanmeanak.stdak.nanstdak.varak.nanvarak.momentnth moment over one or all levels of nesting.ak.corrak.covarak.ptpak.linear_fitak.softmaxNotes for reviewers
axis=None(scalar result) andaxis=int(group-wise);nan*variants share "…, treating NaN values as missing." and keep the verbatim "Like #ak.X, but…" text in the body.ak.softmaxdeviates deliberately ("over the innermost level of nesting"): its implementation only supports the innermost axis and raisesNotImplementedErrorotherwise.ak.argmin/ak.argmaxread "Returns the index of the minimum/maximum value…"; the "…, returning integer indexes" register ofak.argcartesiandid not fit the line budget with the modes tail.nanargmin's Args block documentsmask_identitytwice, andak.mean's first walkthrough doctest is malformed inmain(missing...continuation prefixes).Test plan
Args:blocks and doctests byte-identical; no original narrative text lost.Part of #3980. Draft for initial review; will mark ready once CI passes and the preview is checked.
AI assistance disclosure
Drafted with Claude Code: summaries drafted by Claude Opus 4.8, adversarially verified against the implementations by independent Claude Opus 4.8 agents, mechanically validated (docstring-only changes, original text preserved), and reviewed by a human before submission.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com