5.0.2

Bump version: 5.0.2rc → 5.0.2

2.0.0 - April 18th, 2017

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= 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).

1.1.1

Bug Fixes

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

1.1.0

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).

1.0.0

Added author_email to setup.py

0.7.0

New Features

• Added the D104 error code - "Missing docstring in public package". This new
  error is turned on by default. Missing docstring in __init__.py files which
  previously resulted in D100 errors ("Missing docstring in public module")
  will now result in D104 (#105, #127).
• Added the D105 error code - "Missing docstring in magic method'. This new
  error is turned on by default. Missing docstrings in magic method which
  previously resulted in D102 error ("Missing docstring in public method")
  will now result in D105. Note that exceptions to this rule are variadic
  magic methods - specifically __init__, __call__ and __new__, which
  will be considered non-magic and missing docstrings in them will result
  in D102 (#60, #139).
• Support the option to exclude all error codes. Running pep257 with
  --select= (or select= in the configuration file) will exclude all errors
  which could then be added one by one using add-select. Useful for projects
  new to pep257 (#132, #135).
• Added check D211: No blank lines allowed before class docstring. This change
  is a result of a change to the official PEP257 convention. Therefore, D211
  will now be checked by default instead of D203, which required a single
  blank line before a class docstring (#137).
• Configuration files are now handled correctly. The closer a configuration file
  is to a checked file the more it matters.
  Configuration files no longer support explain, source, debug,
  verbose or count (#133).

Bug Fixes

• On Python 2.x, D302 ("Use u""" for Unicode docstrings") is not reported
  if unicode_literals is imported from __future__ (#113, #134).
• Fixed a bug where there was no executable for pep257 on Windows (#73,
  #136).

0.6.0

New Features

• Added support for more flexible error selections using --ignore,
  --select, --convention, --add-ignore and --add-select
  (#96, #123).

Bug Fixes

• Property setter and deleter methods are now treated as private and do not
  require docstrings separate from the main property method (#69, #107).
• Fixed an issue where pep257 did not accept docstrings that are both
  unicode and raw in Python 2.x (#116, #119).
• Fixed an issue where Python 3.x files with Unicode encodings were
  not read correctly (#118).