summaryrefslogtreecommitdiff
path: root/.pydocstyle
diff options
context:
space:
mode:
Diffstat (limited to '.pydocstyle')
-rw-r--r--.pydocstyle12
1 files changed, 12 insertions, 0 deletions
diff --git a/.pydocstyle b/.pydocstyle
new file mode 100644
index 00000000000..dc8da3eaf1f
--- /dev/null
+++ b/.pydocstyle
@@ -0,0 +1,12 @@
+# See https://readthedocs.org/projects/pydocstyle/
+[pydocstyle]
+inherit = false
+# D105 - Missing docstring in magic method
+# D202 - No blank lines allowed after function docstring
+# D203 - 1 blank line required before class docstring
+# D212 - Multi-line docstring summary should start at the first line
+# D213 - Multi-line docstring summary should start at the second line
+# D301 - Use r""" if any backslashes in a docstring
+ignore = D105,D202,D203,D212,D213,D301
+# Do not run on buildscripts/tests/
+match = ^((?!buildscripts\/tests\/).)*$