docs: add summary lines to 11 to_* array-library converter docstrings#4138
Open
TaiSakuma wants to merge 3 commits into
Open
docs: add summary lines to 11 to_* array-library converter docstrings#4138TaiSakuma wants to merge 3 commits into
TaiSakuma wants to merge 3 commits into
Conversation
Member
Author
|
Follow-up per @ikrommyd's review on #4130: the Returns
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
Add a Google-style one-line summary and `Returns:`/`Examples:` section headers to the 11 to_* array-library converters in `src/awkward/operations/`: to_numpy, to_cupy, to_jax, to_torch, to_tensorflow, to_cudf, to_raggedtensor, to_list, to_layout, to_dataframe, to_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>
…#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>
TaiSakuma
force-pushed
the
docs-to-arraylib-docstrings
branch
from
44d52b2 to
c0c3a71
Compare
|
The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR4138 |
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 11 operations in the
to_*array-library converters batch of #3980:to_numpy,to_cupy,to_jax,to_torch,to_tensorflow,to_cudf,to_raggedtensor,to_list,to_layout,to_dataframe,to_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.to_numpyak.to_cupyak.to_jaxak.to_torchak.to_tensorflowak.to_cudfak.to_raggedtensorak.to_listak.to_layoutak.to_dataframeak.to_rdataframeNotes for reviewers
to_numpy/to_cupy/to_jax/to_torch/to_tensorflow/to_raggedtensor— each raises on unsupported layouts, and their bodies already say so.to_cudfdeliberately omits it (its body makes no such claim; failure there is version-gated, not data-shape).ak.to_layoutdeviates from the "Converts an Awkward Array…" register on purpose: it accepts arbitrary array-like data and returns a low-level layout.ak.to_jaxsays "JAX Array" (the modern term); the body's "JAX Device Array" stays verbatim.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