Skip to content

Commit 271defc

Browse files
BUG: Account for args and kwargs on same line
Check for variations on "*args, **kwargs" while loading in the documentation parameters, and load them in separately if found.
1 parent 3814799 commit 271defc

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

scripts/validate_docstrings.py

+11-4
Original file line numberDiff line numberDiff line change
@@ -422,10 +422,17 @@ def needs_summary(self):
422422

423423
@property
424424
def doc_parameters(self):
425-
return collections.OrderedDict(
426-
(name, (type_, "".join(desc)))
427-
for name, type_, desc in self.doc["Parameters"]
428-
)
425+
var_arg_combinations = {"*args, **kwargs", "*args, **kwds", "**kwargs, *args", "**kwds, *args"}
426+
docs = collections.OrderedDict()
427+
for name, type_, desc in self.doc["Parameters"]:
428+
info = (type_, desc)
429+
if name in var_arg_combinations:
430+
args = name.split(", ")
431+
docs[args[0]] = info
432+
docs[args[1]] = info
433+
else:
434+
docs[name] = info
435+
return docs
429436

430437
@property
431438
def signature_parameters(self):

0 commit comments

Comments
 (0)