STY: Reword first lines of example.py docstrings #246
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Running doc/example.py through pydocstyle
using the "numpy" conventions turns up the following violations for the
module docstring:
(found 0)
This
exclamation point (not 'd')
And the following violation for the
foo()
function docstring:'A')
This change slightly rewords the first line of both docstrings to better
model how docstrings should begin:
own line, and remove the superflous "This is the" introduction.
foo()
function docstring to rephrase the first lineas a command (following the PEP 257 convention).
After this change, pydocstyle finds no violations.