This repository was archived by the owner on Nov 3, 2023. It is now read-only.
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=
(orselect=
in the configuration file) will exclude all errors
which could then be added one by one usingadd-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 supportexplain
,source
,debug
,
verbose
orcount
(#133).
Bug Fixes