pydocstyle

What's Changed

• Fix false positive of google convention missing args descriptions by @stinovlas in #619

New Contributors

• @stinovlas made their first contribution in #619

Full Changelog: 6.2.1...6.2.2

What's Changed

• Add https protocol on websites at the README.rst by @realFranco in #611
• Add Python 3.11 to the testing by @cclauss in #612
• requirements/docs.txt: Use current versions of Jinja2 and sphinx by @cclauss in #615
• Use tomllib/tomli for reading .toml configs by @mgorny in #608
• Docs: pydocstyle supports Python 3.7 through 3.11. by @cclauss in #616

New Contributors

• @realFranco made their first contribution in #611
• @cclauss made their first contribution in #612
• @mgorny made their first contribution in #608

Full Changelog: 6.2.0...6.2.1

What's Changed

• Gitpod-ify the repository by @samj1912 in #548
• Updating readme to reflect support for Python 3.9 by @sanders41 in #545
• Exempt properties from D401 by @TomFryers in #546
• Add support for Python 3.10 by @hugovk in #554
• Fix CI for python 3.10 by @samj1912 in #565
• Add D419: Add and switch to "Docstring is empty" error code by @thejcannon in #559
• Allow for hanging indent when documenting args in Google style by @rmorshea in #564
• Fix match option to only consider basename when given a path argument by @oczkoisse in #550
• Typo fix in docs/error_codes.rst by @Daniel-Mietchen in #578
• docs: Fix double-dash converted to en-dash by @wjandrea in #579
• Fix test warnings and improve lint configuration by @aphedges in #584
• Fix broken CI checks by @aphedges in #585
• Move tool configs to pyproject.toml by @Mr-Pepe in #588
• Add github action to be able to release on published tag by @Pierre-Sassoulas in #582
• Typo by @Fokko in #598
• Move to poetry and automated relases via Github UI by @samj1912 in #614

New Contributors

• @sanders41 made their first contribution in #545
• @TomFryers made their first contribution in #546
• @thejcannon made their first contribution in #559
• @rmorshea made their first contribution in #564
• @oczkoisse made their first contribution in #550
• @Daniel-Mietchen made their first contribution in #578
• @wjandrea made their first contribution in #579
• @aphedges made their first contribution in #584
• @Mr-Pepe made their first contribution in #588
• @Pierre-Sassoulas made their first contribution in #582
• @Fokko made their first contribution in #598

Full Changelog: 6.1.1...6.2.0

Bug Fixes

• Split --source by lines instead of by characters (#536).

New Features

• Enable full toml configuration and pyproject.toml (#534).

Major Updates

• Support for Python 3.5 has been dropped (#510).

New Features

• Add flag to disable # noqa comment processing in API (#485).

• Methods, Functions and Nested functions that have a docstring now throw D418 (#511).

• Methods decorated with @overload no longer reported as D102 (#511).

• Functions and nested functions decorated with @overload no longer reported as D103 (#511).

Bug Fixes

• Treat "package" as an imperative verb for D401 (#356).

• Fix the parsing of decorated one line functions (#499).

Bug Fixes

• Fix IndexError crash on one-line backslashed docstrings (#506).

New Features

• Skip function arguments prefixed with _ in D417 check (#440).

Bug Fixes

• Update convention support documentation (#386, #393)

• Detect inner asynchronous functions for D202 (#467)

• Fix indentation error while parsing class methods (#441).

• Fix a bug in parsing Google-style argument description. The bug caused some argument names to go unreported in D417 (#448).

• Fixed an issue where skipping errors on module level docstring via #noqa failed when there where more prior comments (#446).

• Support backslash-continued descriptions in docstrings (#472).

• Correctly detect publicity of modules inside directories (#470, #494).

Bug Fixes

• Fix DeprecationWarning / SyntaxError "invalid escape sequence" with Python 3.6+ (#445).

Bug Fixes

• Fixed an issue where AttributeError was raised when parsing the parameter section of a class docstring (#434, #436).

Major Updates

• Support for Python 3.4 has been dropped (#402).

New Features

• Extend support for detecting missing arguments in Google style docstrings to method calls (#384).

• Extend support for detecting missing argument description in Numpy style docstrings (#407).

• Added support for Python 3.8 (#423).

• Allow skipping errors on module level docstring via #noqa (#427).

• Whitespace is ignored with set options split across multiple lines (#221).

Bug Fixes

• Remove D413 from the google convention (#430).

• Remove D413 from the pep257 convention (#404).

• Replace semicolon with colon in D416 messages. (#409)

• D301 (Use r""" if any backslashes in a docstring) does not trigger on backslashes for line continuation or unicode literals \u... and \N... anymore. These are considered intended elements of the docstring and thus should not be escaped by using a raw docstring (#365).

• Fix decorator parsing (#411).

• Google-style sections no longer cause false errors when used with Numpy-style sections (#388, #424).

• D202: Allow a blank line after function docstring when followed by declaration of an inner function or class (#395, #426).

• Fix D401 and D404 checks not working for docstrings containing only one word and ending with non-alpha character (#421)

Bug Fixes

• D401: Fixed a false positive where one stem had multiple imperative forms, e.g., init and initialize / initiate (#382).

• Fix parser hanging when there's a comment directly after __all__ (#391, #366).

• Fixed RST error in table which resulted in the online documentation missing the violation code table (#396).

• Fixed IndentationError when parsing function arguments (#392).

Major Updates

• Support for Python 2.x and PyPy has been dropped (#340).

• Added initial support for Google convention (#357).

New Features

• Added pre-commit hook (#346)

Bug Fixes

• Fix parsing tuple syntax __all__ (#355, #352).

Major Updates

• Support for Python 3.3 has been dropped (#315, #316).

• Added support for Python 3.7 (#324).

New features

• Violations are now reported on the line where the docstring starts, not the line of the def/class it corresponds to (#238, #83).

• Updated description of pep257 and numpy conventions (#300).

• __all__ parsing is now done on a best-effort basis - if __all__ can't be statically determined, it will be ignored (#320, #313).

Bug Fixes

• Fixed a false-positive recognition of section names causing D405 to be reported (#311, #317).

• Fixed a bug where functions that don't end with a newline will sometimes raise an exception (#321, #336).

Bug Fixes

• Changed wheel configuration to be NOT universal, as #281 added configparser as a dependency for Python 2.7.

• Updated usage documentation.

New Features

• Public nested classes missing a docstring are now reported as D106 instead of D101 (#198, #261).

• __init__ methods missing a docstring are now reported as D107 instead of D102 (#273, #277).

• Added support for Python 3.6 (#270).

• Specifying an invalid error code prefix (e.g., --select=D9) will print a warning message to stderr (#253, #279).

• Configuration files now support multiple-lined entries (#250, #281).

• Improved description of how error selection works in the help section (#231, #283).

Bug Fixes

• Fixed an issue where the --source flag would result in improperly spaced output (#256, #257, #260).

• Fixed an issue where if a first word in a docstring had Unicode characters and the docstring was not a unicode string, an exception would be raised (#258, #264).

• Configuration files that were specified by CLI and don't contain a valid section name will now issue a warning to stderr (#276, #280).

• Removed D107 from the numpy convention (#288).

Major Updates

Support for numpy conventions verification has been added (#129, #226). Support for Python 2.6 has been dropped (#206, #217). Support for PyPy3 has been temporarily dropped, until it will be equivalent to CPython 3.3+ and supported by pip (#223). Support for the pep257 console script has been dropped. Only the pydocstyle console script should be used (#216, #218). Errors are now printed to stdout instead of stderr (#201, #210).

New Features

Decorator-based skipping via --ignore-decorators has been added (#204). Support for using pycodestyle style wildcards has been added (#72, #209). Superfluous opening quotes are now reported as part of D300 (#166, #225). Fixed a false-positive recognition of D410 and added D412 (#230, #233). Added --config=<path> flag to override the normal config file discovery and choose a specific config file (#117, #247). Support for specifying error codes with partial prefix has been added, e.g., --select=D101,D2 (#72, #209). All configuration file can now have the .ini extension (#237). Added better imperative mood checks using third party stemmer (#235, #68).

Bug Fixes

Made parser more robust to bad source files (#168, #214) Modules are now considered private if their name starts with a single underscore. This is a bugfix where “public module” (D100) was reported regardless of module name (#199, #222). Removed error when all is a list (#62, #227). Fixed a bug where the @ sign was used as a matrix multiplication operator in Python 3.5, but was considered a decorator by the parser (#246, #191).

Bug Fixes

• Fixed an issue where the flake8-docstrings failed when accessing some public API from pydocstyle.

Major Updates

• pydocstyle is no longer a single file. This might make it difficult for some users to just add it to their project, but the project has reached certain complexity where splitting it into modules was necessary (#200).

New Features

• Added the optional error codes D212 and D213, for checking whether the summary of a multi-line docstring starts at the first line, respectively at the second line (#174).
• Added D404 - First word of the docstring should not be “This”. It is turned off by default (#183).
• Added the ability to ignore specific function and method docstrings with inline comments:
  “# noqa” skips all checks.
  “# noqa: D102,D203” can be used to skip specific checks.

Bug Fixes

• Fixed an issue where file paths were printed in lower case (#179, #181).
• The error code D300 is now also being reported if a docstring has uppercase literals (R or U) as prefix (#176).
• Fixed a bug where an all error was reported when all was imported from another module with a different name (#182, #187).
• Fixed a bug where raise X from Y syntax caused pydocstyle to crash (#196, #200).

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 (#145).

• 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 (#13, #146).

• Added the D403 error code - "First word of the first line should be properly capitalized". This new error is turned on by default (#164, #165, #170).

• Added support for .pydocstylerc and as configuration file name (#140, #173).

Bug Fixes

• Fixed an issue where a NameError was raised when parsing complex definitions of __all__ (#142, #143).

• Fixed a bug where D202 was falsely reported when a function with just a docstring and no content was followed by a comment (#165).

• Fixed wrong __all__ definition in main module (#150, #156).

• Fixed a bug where an AssertionError could occur when parsing __future__ imports (#154).

Older Versions

Note

Versions documented below are before renaming the project from pep257 to pydocstyle.