Skip to content

Commit d38a162

Browse files
committed
DOC: Validation script checks for tabs
Add a check to validate the docstrings dont have tabs. The documentation uses whitespace only, adding the check will prevent tabs being added in the sprint or future submissions
1 parent 4131149 commit d38a162

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

scripts/validate_docstrings.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,10 @@ def validate_one(func_name):
455455
if not rel_desc:
456456
errs.append('Missing description for '
457457
'See Also "{}" reference'.format(rel_name))
458+
459+
if "\t" in doc.raw_doc:
460+
errs.append('Tabs found in the docstring, please use whitespace only')
461+
458462
examples_errs = ''
459463
if not doc.examples:
460464
errs.append('No examples section found')

0 commit comments

Comments
 (0)