prospector.yml

inherits:
  - default

# sync with pyproject.toml
max-line-length: 132

# pylint
pylint:
  disable:
    - import-error  # TODO: something going wrong as complaining can't import dependencies
    - unsubscriptable-object  # TODO: pylint doesn't yet (22-01-2020) support Py 3.9
    - no-else-return  # Probably bad style but this is cluttering the report
    # https://docs.pylint.org/en/latest/faq.html#i-am-using-another-popular-linter-alongside-pylint-which-messages-should-i-disable-to-avoid-duplicates
    - too-many-branches  # McCabe duplication
    - logging-fstring-interpolation  # f-strings are quicker than %-formatting

# pydocstyle
pep257:
  run: true
# Codes: https://pydocstyle.readthedocs.io/en/latest/error_codes.html
  disable: [
    # Not part of PEP257:
      D203,  # 1 blank line required before class docstring
      D213,  # Multi-line docstring summary should start at the second line
      D215,  # Section underline is over-indented

      D404,  # First word of the docstring should not be This
      D406,  # Section name should end with a newline
      D407,  # Missing dashed underline after section
      D408,  # Section underline should be in the line following the section’s name
      D409,  # Section underline should match the length of its name

    # Google docstring style guide:

    # Examples of class docstrings without trailing blank line
#      D204,  # 1 blank line required after class docstring
    # First line can end with a full stop, exclamation mark, or question mark
      D400,  # First line should end with a full stop
    # Style guide requires usage of descriptive mood
      D401,  # First line should be in imperative mood
  ]
  enable: [
  # Google docstring style guide:
    D212,  # Multi-line docstring summary should start at the first line
    D415,  # First line should end with a full stop, exclamation mark, or question mark
    D416,  # Section name should end with a colon
    D417,  # Missing argument descriptions in the docstring
  ]