D401: Allow multiple imperative forms of the same stem. #382
Conversation
Nurdok
commented
Jul 20, 2019
•
Nurdok
commented
- Added tests.
- Added a line to the release notes.
| @@ -16,7 +16,8 @@ def docstring_bad_ignore_one(): # noqa: D400,D401,D415 | |||
| pass | |||
|
|
|||
|
|
|||
| @expect("D401: First line should be in imperative mood ('Run', not 'Runs')") | |||
| @expect("D401: First line should be in imperative mood " | |||
| "(perhaps 'Run', not 'Runs')") | |||
There was a problem hiding this comment.
"perhaps y, not x" reads clumsily to me. Adding "perhaps y" suggests a lot less confidence in the recommendation, while "not x" seems very confident.
Maybe "eg. y instead of x"?
There was a problem hiding this comment.
Seeing as the bug was caused by two different imperative forms of the same stem, I was indeed going for a less confident recommendation.
Some options here:
- perhaps 'Run', not 'Runs'
- 'Run', not 'Runs'
- e.g., 'Run' instead of 'Runs'
- perhaps 'Run' instead of 'Runs'
I chose (1) because it's more clear that 'Runs' is definitely bad while 'Run' is not necessarily the right choice.
@shacharoo LMKWYT
There was a problem hiding this comment.
I'm merging so that other PRs are unblocked, I think the current phrasing is fine for now, but we can revisit it before the next release.
There was a problem hiding this comment.
Thanks. (I like 3 and 4 for what it's worth).
