This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
D413 problems since pydocstyle 4.0.0 #401
Comments
3 tasks
From what I can see, the change that causes D413 to be throw is the addition of new section names in pydocstyle 4.0. Earlier Arguments or Keyword Arguments were not identified as sections, and as a result they never threw D413. Given the examples, it seems reasonable to exclude D413 from the pep257 convention entirely. |
2 tasks
justinludwig
added a commit
to justinludwig/pydocstyle
that referenced
this issue
Nov 26, 2019
As none of the examples in the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) show a docstring with an extra blank line at the end (see the [3.8.1 Docstrings](https://google.github.io/styleguide/pyguide.html#381-docstrings) section in particular), error D413 should be excluded from the default "google" convention. See PyCQA#429 for a test case with examples from the Google Python Style Guide; see also PyCQA#401 for D413 in relation to the "pep257" convention.
2 tasks
Nurdok
pushed a commit
that referenced
this issue
Nov 30, 2019
As none of the examples in the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) show a docstring with an extra blank line at the end (see the [3.8.1 Docstrings](https://google.github.io/styleguide/pyguide.html#381-docstrings) section in particular), error D413 should be excluded from the default "google" convention. See #429 for a test case with examples from the Google Python Style Guide; see also #401 for D413 in relation to the "pep257" convention.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Updating
pydocstyle
from version 3.0.0 to version 4.0.0 or 4.0.1 throw numerous newD413
(and fewD412
) issues on code that passes with version 3.0.0.Example: The following code:
throws 'only' one issue with
pydocstyle
ver. 3.0.0:but 4 with ver. 4.0.1 (or 4.0.0), even with the original PEP-257 example (from https://www.python.org/dev/peps/pep-0257/):
Actually, I think that no of these example docstrings should give an issue (at least in pep257 mode). The only way to get rid of this error is to put an empty line before the closing quotes, but this isn't a PEP 257 rule?
The text was updated successfully, but these errors were encountered: