31 lines
1.2 KiB
INI
31 lines
1.2 KiB
INI
|
[pydocstyle]
|
||
|
|
; All error codes found here:
|
||
|
|
; http://www.pydocstyle.org/en/3.0.0/error_codes.html
|
||
|
|
;
|
||
|
|
; Ignored:
|
||
|
|
; D1 - Missing docstring error codes
|
||
|
|
;
|
||
|
|
; Selected:
|
||
|
|
; D2 - Whitespace error codes
|
||
|
|
; D3 - Quote error codes
|
||
|
|
; D4 - Content related error codes
|
||
|
|
select=D2,D3,D4
|
||
|
|
|
||
|
|
; Extra ignores:
|
||
|
|
; D200 - One-line docstring should fit on one line with quotes
|
||
|
|
; D203 - 1 blank line required before class docstring
|
||
|
|
; D204 - 1 blank line required after class docstring
|
||
|
|
; D205 - 1 blank line required between summary line and description
|
||
|
|
; D212 - Multi-line docstring summary should start at the first line
|
||
|
|
; D302 - Use u""" for Unicode docstrings
|
||
|
|
; D400 - First line should end with a period
|
||
|
|
; D401 - First line should be in imperative mood
|
||
|
|
; D412 - No blank lines allowed between a section header and its content
|
||
|
|
add-ignore=D200,D203,D204,D205,D212,D302,D400,D401,D412
|
||
|
|
|
||
|
|
; Explanation:
|
||
|
|
; D400 - Enabling this error code seems to make it a requirement that the first
|
||
|
|
; sentence in a docstring is not split across two lines. It also makes it a
|
||
|
|
; requirement that no docstring can have a multi-sentence description without a
|
||
|
|
; summary line. Neither one of those requirements seem appropriate.
|