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

Commit d8f0931

Browse files
gibfahnsambhav
andauthored
Allow package as an imperative verb in D401 (#356)
If a docstring starts with "Package" it's probably something like: ```python """Package the files into a tarball.""" ``` So don't flag it in D401. Co-authored-by: Sambhav Kothari <[email protected]>
1 parent 408f962 commit d8f0931

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/release_notes.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ New Features
1616

1717
* Add flag to disable `# noqa` comment processing in API (#485).
1818

19+
Bug Fixes
20+
21+
* Treat "package" as an imperative verb for D401 (#356).
22+
1923
5.1.1 - August 29th, 2020
2024
---------------------------
2125

2226
Bug Fixes
2327

2428
* Fix ``IndexError`` crash on one-line backslashed docstrings (#506).
2529

26-
2730
5.1.0 - August 22nd, 2020
2831
---------------------------
2932

@@ -43,7 +46,6 @@ Bug Fixes
4346
* Support backslash-continued descriptions in docstrings (#472).
4447
* Correctly detect publicity of modules inside directories (#470, #494).
4548

46-
4749
5.0.2 - January 8th, 2020
4850
---------------------------
4951

@@ -122,7 +124,6 @@ Bug Fixes
122124

123125
* Fix parsing tuple syntax ``__all__`` (#355, #352).
124126

125-
126127
3.0.0 - October 14th, 2018
127128
--------------------------
128129

src/pydocstyle/data/imperatives.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ open
137137
output
138138
override
139139
overwrite
140+
package
140141
pad
141142
parse
142143
partial

src/pydocstyle/data/imperatives_blacklist.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ module
6363
new
6464
number
6565
optional
66-
package
6766
placeholder
6867
reference
6968
result

0 commit comments

Comments
 (0)