Repository navigation
numpydoc+google: one param per listed name - #182
Merged
Merged
Conversation
A head that lists several names, as in Numpydoc's "x, y : int" or Google's "x, y (int): text", gave one param named "x, y". It now gives one param per name, each with the same type and description. Compose writes them one per name, which reads back the same.
rr-
force-pushed
the
rework/40-multi-names
branch
from
November 7, 2026 00:39
ad073b9 to
ed1ee0f
Compare
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.
A head that lists several names now gives one param per name, each with the same type and description:
x, y : intx, y (int): text, and*args, **kwargs: textOnly a head that is a plain list of names (with optional
*/**) is split, so a head likex, or else (int)stays one param. Compose writes the params one per name, which reads back the same.Case diffs: 14 corpus cases (numpy, pandas, scipy), all
x1, x2-style heads such asaxis1, axis2,c1, c2,formats, names, titles, aligned, byteorderand*args, **kwargs, now one param per name.Parity against origin/main: 15 of 29183 docstrings differ, case 14, stdlib 1 (
filecmp.dircmp, whose Google read now givesleft_list/right_listandleft_only/right_onlyone param each). No docstring parses only in base, so no stdlib docstring newly makes strictparseraise.