Add a .pydocstylerc.

This commit is contained in:
Florian Bruhin 2016-01-30 23:30:12 +01:00
parent 39ca471685
commit dc07f7ca9b
3 changed files with 15 additions and 10 deletions

13
.pydocstylerc Normal file
View File

@ -0,0 +1,13 @@
[pydocstyle]
# Disabled checks:
# D102: Missing docstring in public method (will be handled by others)
# D103: Missing docstring in public function (will be handled by others)
# D104: Missing docstring in public package (will be handled by others)
# D105: Missing docstring in magic method (will be handled by others)
# D209: Blank line before closing """ (removed from PEP257)
# D211: No blank lines allowed before class docstring
# (PEP257 got changed, but let's stick to the old standard)
# D402: First line should not be function's signature (false-positives)
ignore = D102,D103,D104,D105,D209,D211,D402
match = (?!resources|test_*).*\.py
inherit = false

View File

@ -32,6 +32,7 @@ exclude .eslintignore
exclude doc/help exclude doc/help
exclude .appveyor.yml exclude .appveyor.yml
exclude .travis.yml exclude .travis.yml
exclude .pydocstylerc
exclude misc/appveyor_install.py exclude misc/appveyor_install.py
global-exclude __pycache__ *.pyc *.pyo global-exclude __pycache__ *.pyc *.pyo

11
tox.ini
View File

@ -155,16 +155,7 @@ basepython = python3
skip_install = true skip_install = true
passenv = PYTHON LANG passenv = PYTHON LANG
deps = pydocstyle==1.0.0 deps = pydocstyle==1.0.0
# Disabled checks: commands = {envpython} -m pydocstyle scripts tests qutebrowser
# D102: Missing docstring in public method (will be handled by others)
# D103: Missing docstring in public function (will be handled by others)
# D104: Missing docstring in public package (will be handled by others)
# D105: Missing docstring in magic method (will be handled by others)
# D209: Blank line before closing """ (removed from PEP257)
# D211: No blank lines allowed before class docstring
# (PEP257 got changed, but let's stick to the old standard)
# D402: First line should not be function's signature (false-positives)
commands = {envpython} -m pydocstyle scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py'
[testenv:flake8] [testenv:flake8]
basepython = python3 basepython = python3