Add basic pydocstyle configuration

lsst · Mar 5, 2021 · 4dffad1 · 4dffad1
1 parent b657896
commit 4dffad1
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/setup.cfg b/setup.cfg
@@ -59,3 +59,10 @@ flake8-ignore = E133 E226 E228 N802 N803 N806 N812 N815 N816 W503
 # The matplotlib test may not release font files.
 # Some unit tests open registry database in setUpClass.
 open_files_ignore = "*.ttf" "gen3.sqlite3"
+
+[pydocstyle]
+convention = numpy
+# Our coding style does not require docstrings for magic methods (D105)
+# Our docstyle documents __init__ at the class level (D107)
+# We allow methods to inherit docstrings and this is not compatible with D102.
+add-ignore = D107, D105, D102