.prospector.yml

# prospector configuration file

---

output-format: grouped

strictness: medium
doc-warnings: true
test-warnings: true
member-warnings: false

ignore-paths:
  - docs
  - build

pyroma:
    run: true

pycodestyle:
    full: true

pylint:
    disable: [
        C0114, # we don't check for module docstrings, because we have many separate files for single classes
    ]

pydocstyle:
    disable: [
        # Disable because not part of PEP257 official convention:
        # see http://pep257.readthedocs.io/en/latest/error_codes.html
        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
        D404,  # First word of the docstring should not be This
        # The following list excludes things that are irrelevant to the Google style
        D203, D204, D213, D215, D400, D401, D404, D406, D407, D408, D409, D413,
    ]

pyflakes:
    disable: [
        F401,  # unused import: already checked by pylint
    ]