tox: Switch from pep257 to pydocstyle.

Major Updates
-------------

The project was renamed to pydocstyle and the new release will be 1.0.0!

New Features
------------

- Added support for Python 3.5.
- Classes nested inside classes are no longer considered private. Nested
  classes are considered public if their names are not prepended with an
  underscore and if their parent class is public, recursively.
- Added the D403 error code - "First word of the first line should be properly
  capitalized". This new error is turned on by default.
- Added support for .pydocstylerc and as configuration file name.

Bug Fixes
---------

- Fixed an issue where a NameError was raised when parsing complex definitions
  of __all__.
- Fixed a bug where D202 was falsely reported when a function with just a
  docstring and no content was followed by a comment.
- Fixed wrong __all__ definition in main module.
- Fixed a bug where an AssertionError could occur when parsing __future__
  imports.
This commit is contained in:
Florian Bruhin 2016-01-30 23:23:21 +01:00
parent 6af1cce45f
commit 39ca471685
2 changed files with 7 additions and 7 deletions

View File

@ -16,7 +16,7 @@ env:
- TESTENV=unittests-nodisp
- TESTENV=misc
- TESTENV=vulture
- TESTENV=pep257
- TESTENV=pydocstyle
- TESTENV=flake8
- TESTENV=pyroma
- TESTENV=check-manifest
@ -53,7 +53,7 @@ matrix:
- os: osx
env: TESTENV=vulture
- os: osx
env: TESTENV=pep257
env: TESTENV=pydocstyle
- os: osx
env: TESTENV=flake8
- os: osx

10
tox.ini
View File

@ -4,7 +4,7 @@
# and then run "tox" from this directory.
[tox]
envlist = py34,py35-cov,misc,vulture,pep257,flake8,pylint,pyroma,check-manifest
envlist = py34,py35-cov,misc,vulture,pydocstyle,flake8,pylint,pyroma,check-manifest
[testenv]
# https://bitbucket.org/hpk42/tox/issue/246/ - only needed for Windows though
@ -150,21 +150,21 @@ commands =
{envpython} -m pylint scripts qutebrowser --output-format=colorized --reports=no
{envpython} scripts/dev/run_pylint_on_tests.py --output-format=colorized --reports=no
[testenv:pep257]
[testenv:pydocstyle]
basepython = python3
skip_install = true
passenv = PYTHON LANG
deps = pep257==0.7.0
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: Now b lank lines allowed before class docstring
# 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 pep257 scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py'
commands = {envpython} -m pydocstyle scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py'
[testenv:flake8]
basepython = python3