diff options
| author | Florian Bruhin <git@the-compiler.org> | 2016-01-30 23:30:12 +0100 |
|---|---|---|
| committer | Florian Bruhin <git@the-compiler.org> | 2016-01-30 23:39:55 +0100 |
| commit | dc07f7ca9bf68785fe01829203d06e8af6a5ac51 (patch) | |
| tree | ba45aa6dcc13902e19f7092dddc20d353057db6a | |
| parent | 39ca47168579928b8cba09f07d0f9da499bbf81d (diff) | |
| download | qutebrowser-dc07f7ca9bf68785fe01829203d06e8af6a5ac51.tar.gz qutebrowser-dc07f7ca9bf68785fe01829203d06e8af6a5ac51.zip | |
Add a .pydocstylerc.
| -rw-r--r-- | .pydocstylerc | 13 | ||||
| -rw-r--r-- | MANIFEST.in | 1 | ||||
| -rw-r--r-- | tox.ini | 11 |
3 files changed, 15 insertions, 10 deletions
diff --git a/.pydocstylerc b/.pydocstylerc new file mode 100644 index 000000000..74eb0beff --- /dev/null +++ b/.pydocstylerc @@ -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 diff --git a/MANIFEST.in b/MANIFEST.in index e2dd15509..be33e3cfc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -32,6 +32,7 @@ exclude .eslintignore exclude doc/help exclude .appveyor.yml exclude .travis.yml +exclude .pydocstylerc exclude misc/appveyor_install.py global-exclude __pycache__ *.pyc *.pyo @@ -155,16 +155,7 @@ basepython = python3 skip_install = true passenv = PYTHON LANG deps = pydocstyle==1.0.0 -# 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) -commands = {envpython} -m pydocstyle scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py' +commands = {envpython} -m pydocstyle scripts tests qutebrowser [testenv:flake8] basepython = python3 |