docs: move description text out of Examples: sections in merged files - #4234
Merged
TaiSakuma merged 1 commit intoJul 27, 2026
Merged
Conversation
Per the Examples:-section checklist on scikit-hep#3980: narrative that describes behavior, arguments, or history belongs above Args: in the extended description; Examples: keeps only doctest walkthroughs and their connecting prose; "See also" lines go directly above Args:. Refs scikit-hep#3980. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
|
The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR4234 |
ianna
approved these changes
Jul 24, 2026
ianna
left a comment
ianna
left a comment
Member
There was a problem hiding this comment.
@TaiSakuma - Thanks! It looks better IMHO. Please go ahead and merge it. Thanks.
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
2 participants
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.
The docstring conversions of the #3980 rollout placed some main-description text under
Examples:headers, found in a review comment on PR #4139 and tracked in #4233. This PR applies theExamples:-section checklist to the 17 already-merged files: description paragraphs (behavior, arguments, history) move aboveArgs:into the extended description, relocated verbatim (only re-indented and re-wrapped);Examples:keeps only doctest walkthroughs and their connecting prose; "See also" lines sit directly aboveArgs:.All changes are docstring-only (verified by comparing docstring-stripped ASTs against the previous revision) and every doctest line is byte-identical (verified by comparing the multiset of
>>>/...lines per file).Per-file decisions
ak.copyak.transformmore_arraysparagraphs.ak.from_bufferscontainer,buffer_key, andallow_noncanonical_formparagraphs; theExamples:header is removed because nothing example-like remained (mirrorsak.to_buffersafter the fix on #4139).ak.from_featherak.from_jsonak.from_regularak.argcartesianak.broadcast_arrays::blocks), the broadcasting-rules bullet list, and the "aware of the distinction" paragraph.ak.broadcast_fieldsExamples:contains only a doctest.ak.cartesianak.combinationsak.cartesian).ak.pad_noneclipbehavior note (with its bullet list) and the variable-length caveat.ak.ravelak.unflattenaxisnote, the partition caveat, and "See also #ak.num and #ak.flatten."ak.unzipak.zipdepth_limit=1advice.ak.zip_no_broadcastDrafts were generated with Claude Code and reviewed manually, per the process agreed for #3980.
Closes #4233. Refs #3980.
🤖 Generated with Claude Code