From 9d7d82843a93540498a437383721dc5a5c8b20c8 Mon Sep 17 00:00:00 2001 From: pauladkisson Date: Mon, 2 Oct 2023 10:48:47 +0200 Subject: [PATCH] added comments on excluded sections --- pyproject.toml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index d1add2be..ad69f723 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,15 +23,15 @@ extend-exclude = ''' [tool.numpydoc_validation] checks = [ "all", # report on all checks, except the below - "GL08", - "EX01", - "SA01", - "ES01", + "GL08", # Missing docstring + "EX01", # Missing Example section + "SA01", # Missing See Also section + "ES01", # Missing Extended Summary section ] exclude = [ # don't report on objects that match any of these regex 'test_', 'check_', - 'assert_' + 'assert_', ] override_SS05 = [ # override SS05 to allow docstrings starting with these words ]