added comments on excluded sections

catalystneuro · Oct 2, 2023 · 9d7d828 · 9d7d828
1 parent 04881a0
commit 9d7d828
Showing 1 changed file with 5 additions and 5 deletions.
diff --git 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
 ]