You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#3946 was a pilot that added a Google-style one-line summary to ak.flatten. The rendering pipeline issues it surfaced have since been fixed (#3947, #3948, #3965, #3966, #3972), so the same treatment can now be rolled out to the rest of src/awkward/operations/.
This issue tracks that rollout. Filing it to give contributors a heads-up and avoid duplicate work.
Scope
123 files remain. Only ak_flatten.py has a summary line today.
Per-file recipe
Important
Checklist comments below refine this recipe and take precedence over it — read the comments before drafting or reviewing a batch. Current checklists (last updated 2026-07-23; add new ones here): summary line, Returns:, Examples:.
The existing docstrings follow a consistent shape:
"""Args: ...Returns an array with ... <descriptive paragraph> ..."""
Conversion:
Lift the first sentence of the trailing paragraph into the opening """.
Keep Args: untouched.
Move remaining narrative under Returns: and/or Examples: headers.
Awkward Arrays are immutable (see ak_copy.py), so active-voice verbs ("Returns…", "Creates…", "Converts…") are safe without caveats.
Contributing to a batch
Drafts will be generated with Claude Code and reviewed manually, per agreement in the awkward-uproot meeting.
Do not use closing keywords (closes #N, fixes #N, resolves #N) referencing this issue in batch PRs — that would close the tracking issue before the remaining batches are done. Use Part of #N or Refs #N instead.
Tick the corresponding checkbox below when each PR merges.
Context
#3946 was a pilot that added a Google-style one-line summary to
ak.flatten. The rendering pipeline issues it surfaced have since been fixed (#3947, #3948, #3965, #3966, #3972), so the same treatment can now be rolled out to the rest ofsrc/awkward/operations/.This issue tracks that rollout. Filing it to give contributors a heads-up and avoid duplicate work.
Scope
123 files remain. Only
ak_flatten.pyhas a summary line today.Per-file recipe
Important
Checklist comments below refine this recipe and take precedence over it — read the comments before drafting or reviewing a batch. Current checklists (last updated 2026-07-23; add new ones here): summary line,
Returns:,Examples:.The existing docstrings follow a consistent shape:
Conversion:
""".Args:untouched.Returns:and/orExamples:headers.axis=None(docs: update ak.flatten docstring to Google style #3946 cycled through four drafts before landing on correct wording).Awkward Arrays are immutable (see
ak_copy.py), so active-voice verbs ("Returns…", "Creates…", "Converts…") are safe without caveats.Contributing to a batch
closes #N,fixes #N,resolves #N) referencing this issue in batch PRs — that would close the tracking issue before the remaining batches are done. UsePart of #NorRefs #Ninstead.Batches
all,any,sum,prod,count,count_nonzero,min,max,argmin,argmax,mean,std,var,moment,corr,covar,ptp,linear_fit,softmaxravel,unflatten,zip,unzip,zip_no_broadcast,cartesian,argcartesian,combinations,argcombinations,concatenate,broadcast_arrays,broadcast_fields,pad_nonefill_none,drop_none,is_none,firsts,singletons,mask,nan_to_none,nan_to_numsort,argsort,run_lengths,local_index,numround,real,imag,angle,isclosefull_like,ones_like,zeros_likewith_field,without_field,with_name,with_parameter,without_parameters,with_named_axis,without_named_axis,fields,parametersalmost_equal,array_equal,is_valid,validity_error,is_categorical,is_tuple,categories,enforce_type,values_astype,strings_astypefrom_*array-library converters (8):from_numpy,from_cupy,from_jax,from_torch,from_tensorflow,from_raggedtensor,from_dlpack,from_rdataframefrom_*file/format converters (11):from_arrow,from_arrow_schema,from_parquet,from_feather,from_json,from_avro_file,from_safetensors,from_iter,from_buffers,from_regular,from_categoricalto_*array-library converters (11):to_numpy,to_cupy,to_jax,to_torch,to_tensorflow,to_cudf,to_raggedtensor,to_list,to_layout,to_dataframe,to_rdataframeto_*file/format converters (13):to_arrow,to_arrow_table,to_parquet,to_parquet_dataset,to_parquet_row_groups,metadata_from_parquet,to_feather,to_json,to_safetensors,to_buffers,to_packed,to_regular,to_backendcopy,backend,materialize,transform,where,type,merge_option_of_records,merge_union_of_recordsCo-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com