rewrite docstrings to match numpy style guide

This commit is contained in:
Benedikt Brückmann 2021-05-17 09:56:51 +02:00
parent 660520e3e1
commit d168b9c05b
7 changed files with 400 additions and 208 deletions

View file

@ -40,10 +40,16 @@ output_dir = locale
domain = fdroidserver
directory = locale
[pycodestyle]
ignore = E203,W503
max-line-length = 88
[flake8]
ignore = E203,W503
max-line-length = 88
# Settings for docstrings linter
# we use numpy stlye https://numpydoc.readthedocs.io/en/latest/format.html
# ignored errors are
# * D10*: Missing docstring *
# * rest are the conventions which are ignored by numpy conventions according to http://www.pydocstyle.org/en/stable/error_codes.html
[pydocstyle]
#convention = numpy # cannot be used in combination with ignore, so we list rules seperately.
ignore = D100,D101,D102,D103,D104,D105,D106,D107,D203,D212,D213,D402,D413,D415,D416,D417,E203,W503
max-line-length = 88