docs: add summary lines to 8 from_* array-library converter docstrings#4136
Draft
TaiSakuma wants to merge 2 commits into
Draft
docs: add summary lines to 8 from_* array-library converter docstrings#4136TaiSakuma wants to merge 2 commits into
TaiSakuma wants to merge 2 commits into
Conversation
Add a Google-style one-line summary and `Returns:`/`Examples:` section headers to the 8 from_* array-library converters in `src/awkward/operations/`: from_numpy, from_cupy, from_jax, from_torch, from_tensorflow, from_raggedtensor, from_dlpack, from_rdataframe. 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 Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
…#3980. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
Follow-up per @ikrommyd's review on #4130: the Returns
|
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
Rolls the pilot from #3946 out to the 8 operations in the
from_*array-library converters batch of #3980:from_numpy,from_cupy,from_jax,from_torch,from_tensorflow,from_raggedtensor,from_dlpack,from_rdataframe.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.from_numpyak.from_cupyak.from_jaxak.from_torchak.from_tensorflowak.from_raggedtensorak.from_dlpackak.from_rdataframeNotes for reviewers
to_*siblings ("Converts a/an into an Awkward Array.").ak_from_jax.py's "See also" line references#ak.from_jaxitself (likely meant#ak.from_cupy).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 Sonnet 4.6, 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 Sonnet 4.6 noreply@anthropic.com