We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 20b32e7 commit f2d6449Copy full SHA for f2d6449
scripts/validate_docstrings.py
@@ -497,8 +497,9 @@ def validate_one(func_name):
497
else:
498
returns_errs = []
499
if len(doc.returns) == 1 and doc.returns[0][1]:
500
- returns_errs.append('No name is to be provided when '
501
- 'returning a single value.')
+ returns_errs.append('The first line of the Returns section '
+ 'should contain only the type, unless '
502
+ 'multiple values are being returned.')
503
for name, type_, desc in doc.returns:
504
desc = ''.join(desc)
505
name = '"' + name + '" ' if type_ else ''
0 commit comments