docs: add summary lines to 11 from_* file/format converter docstrings#4137
Merged
TaiSakuma merged 3 commits intoJul 21, 2026
Merged
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
|
TaiSakuma
force-pushed
the
docs-from-formats-docstrings
branch
from
June 30, 2026 22:44
4203ce2 to
0b54a0f
Compare
TaiSakuma
marked this pull request as ready for review
June 30, 2026 22:54
|
The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR4137 |
Add a Google-style one-line summary and `Returns:`/`Examples:` section headers to the 11 from_* file/format converters in `src/awkward/operations/`: from_arrow, from_arrow_schema, from_parquet, from_feather, from_json, from_avro_file, from_safetensors, from_iter, from_buffers, from_regular, from_categorical. 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>
TaiSakuma
force-pushed
the
docs-from-formats-docstrings
branch
from
July 21, 2026 20:30
0b54a0f to
083b93c
Compare
ianna
approved these changes
Jul 21, 2026
ianna
left a comment
Member
There was a problem hiding this comment.
@TaiSakuma - Looks great! I'll approve, please, merge it when the checks are done. Thanks.
TaiSakuma
enabled auto-merge (squash)
July 21, 2026 20:47
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 11 operations in the
from_*file/format converters batch of #3980:from_arrow,from_arrow_schema,from_parquet,from_feather,from_json,from_avro_file,from_safetensors,from_iter,from_buffers,from_regular,from_categorical.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_arrowak.from_arrow_schemaak.from_parquetak.from_featherak.from_jsonak.from_avro_fileak.from_safetensorsak.from_iterak.from_buffersak.from_regularak.from_categoricalNotes for reviewers
ak.from_json's summary ("from a string, bytes, file, or URL") was composed because the original ("Converts a JSON string…") undersold the accepted sources.ak.from_regularreads "one or all regular axes" to coveraxis=None, matching the flatten precedent (and mirroringto_regularin the sibling PR).ak.from_feather's summary fixes the grammar of the lead sentence ("an Feather" → "a Feather"); the original stays verbatim in the body.ak.from_avro_file's summary uses the accurate singular ("an Avro file"); the plural original stays in the body.ak.from_safetensorshad a pre-existing inlineReturns:header; it was merged into the new structure without duplication.ak_from_safetensors.py's_implImportError message says "ak.from_tensorflow" (code, not docstring).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