# prospector configuration file

---

output-format: grouped

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

pyroma:
    run: true

pydocroma:
    run: true

pep8:
     disable: [
        E501,  # Line-length, already controlled by pylint
    ]

pep257:
  run: true
    # see http://pep257.readthedocs.io/en/latest/error_codes.html
  disable: [
      # For short descriptions it makes sense not to end with a period:
      D400,  # First line should end with a period
      # Disable because not part of PEP257 official convention:
      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
      D107, # We are using numpy style and constructor should be documented in class docstring
      D105, # Docstring in magic methods should not be required: we all now what they are for
  ]
