Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit ac34b3a

Browse files
committed
Added release notes for the new D105
1 parent 7c19fa7 commit ac34b3a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/release_notes.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ New Features
1212
previously resulted in D100 errors ("Missing docstring in public module")
1313
will now result in D104 (#105, #127).
1414

15+
* Added the D105 error code - "Missing docstring in magic method'. This new
16+
error is turned on by default. Missing docstrings in magic method which
17+
previously resulted in D102 error ("Missing docstring in public method")
18+
will now result in D105. Note that exceptions to this rule are variadic
19+
magic methods - specifically `__init__`, `__call__` and `__new__`, which
20+
will be considered non-magic and missing docstrings in them will result
21+
in D102 (#60, #139).
22+
1523
* Support the option to exclude all error codes. Running pep257 with
1624
`--select=` (or `select=` in the configuration file) will exclude all errors
1725
which could then be added one by one using `add-select`. Useful for projects

0 commit comments

Comments
 (0)