We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent a8fa74a commit 918946bCopy full SHA for 918946b
scripts/validate_docstrings.py
@@ -235,6 +235,10 @@ def see_also(self):
235
def examples(self):
236
return self.doc['Examples']
237
238
+ @property
239
+ def returns(self):
240
+ return self.doc['Returns']
241
+
242
@property
243
def first_line_ends_in_dot(self):
244
if self.doc:
@@ -436,6 +440,9 @@ def validate_one(func_name):
436
440
for param_err in param_errs:
437
441
errs.append('\t{}'.format(param_err))
438
442
443
+ if not doc.returns:
444
+ errs.append('No returns section found')
445
439
446
mentioned_errs = doc.mentioned_private_classes
447
if mentioned_errs:
448
errs.append('Private classes ({}) should not be mentioned in public '
0 commit comments