prospector: add a configuration file for prospector

The pep257 tool (part of prospector) has two rules: D203: 1 blank line required before class docstring D211: No blank lines allowed before class docstring Which conflict, so turn D203 off. Signed-off-by: Robin Getz <[email protected]>
analogdevicesinc · Apr 23, 2020 · 53d83cc · 53d83cc
1 parent 0864ab8
commit 53d83cc
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/.prospector.yml b/.prospector.yml
@@ -0,0 +1,34 @@
+# prospector configuration file
+
+---
+output-format: grouped
+strictness: veryhigh
+doc-warnings: true
+test-warnings: true
+member-warnings: true
+
+frosted:
+  run: false
+
+pyroma:
+  run: false
+
+mypy:
+  run: false
+
+pydocroma:
+  run: true
+
+pep8:
+  run: true
+  disable: [
+    E501,  # Line-length, already controlled by pylint
+  ]
+
+pep257:
+  run: true
+    # see http://pep257.readthedocs.io/en/latest/error_codes.html
+  disable: [
+    D203,  # 1 blank line required before class docstring
+           # conflicts with D0211, No blank lines allowed before class docstring
+  ]