Skip to content

Commit 2ec7e31

Browse files
committed
WARN instead of ERROR for missing doc strings on private members in doc tests
1 parent 7790712 commit 2ec7e31

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

tests/test_docs.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ def test_verify_docs():
6868
# Ignore doc-less BaseException inheritance
6969
err = None
7070
elif doc is None:
71+
# Set level to WARN for private/internal objects
72+
if shortname.startswith('_'):
73+
level = 'WARN'
7174
err = 'Missing __doc__ for: %s (type %s)' % (n, type(o))
7275
elif not re.search(r':', doc):
7376
err = 'Missing Doxygen tag for: %s (type %s):\n---\n%s\n---' % (n, type(o), doc)

0 commit comments

Comments
 (0)