github PyCQA/pydocstyle 0.7.0

latest releases: 6.3.0, 6.2.3, 6.2.2...
8 years ago

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

Don't miss a new pydocstyle release

NewReleases is sending notifications on new releases.