Skip to content

Commit dc07f7c

Browse files
committed
Add a .pydocstylerc.
1 parent 39ca471 commit dc07f7c

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

.pydocstylerc

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

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ exclude .eslintignore
3232
exclude doc/help
3333
exclude .appveyor.yml
3434
exclude .travis.yml
35+
exclude .pydocstylerc
3536
exclude misc/appveyor_install.py
3637

3738
global-exclude __pycache__ *.pyc *.pyo

tox.ini

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -155,16 +155,7 @@ basepython = python3
155155
skip_install = true
156156
passenv = PYTHON LANG
157157
deps = pydocstyle==1.0.0
158-
# Disabled checks:
159-
# D102: Missing docstring in public method (will be handled by others)
160-
# D103: Missing docstring in public function (will be handled by others)
161-
# D104: Missing docstring in public package (will be handled by others)
162-
# D105: Missing docstring in magic method (will be handled by others)
163-
# D209: Blank line before closing """ (removed from PEP257)
164-
# D211: No blank lines allowed before class docstring
165-
# (PEP257 got changed, but let's stick to the old standard)
166-
# D402: First line should not be function's signature (false-positives)
167-
commands = {envpython} -m pydocstyle scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py'
158+
commands = {envpython} -m pydocstyle scripts tests qutebrowser
168159

169160
[testenv:flake8]
170161
basepython = python3

0 commit comments

Comments
 (0)