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

Commit e00dc31

Browse files
committed
Updated documentation, included D404 in our self-test.
1 parent 194d554 commit e00dc31

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

docs/error_codes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ check only error codes that are part of the `PEP257
1515
<http://www.python.org/dev/peps/pep-0257/>`_ official convention.
1616

1717
All of the above error codes are checked for by default except for D203,
18-
D212 and D213.
18+
D212, D213 and D404.

docs/release_notes.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,17 @@ Release Notes
77
Current Development Version
88
---------------------------
99

10+
New Features
11+
1012
* Added the optional error codes D212 and D213, for checking whether
1113
the summary of a multi-line docstring starts at the first line,
1214
respectively at the second line (#174).
1315

16+
* Added D404 - First word of the docstring should not be `This`. It is turned
17+
off by default (#183).
18+
19+
Bug Fixes
20+
1421
* The error code D300 is now also being reported if a docstring has
1522
uppercase literals (``R`` or ``U``) as prefix (#176).
1623

tox.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,4 @@ addopts = -rw
2828
[pep257]
2929
inherit = false
3030
convention = pep257
31+
add-select = D404

0 commit comments

Comments
 (0)