Use present imperative for docstrings #16
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[PEP-257][pep257] covers docstring conventions, and has this to say on
the topic:
> The docstring is a phrase ending in a period. It prescribes the
> function or method's effect as a command ("Do this", "Return that"),
> not as a description; e.g. don't write "Returns the pathname ...".
[pep257]: https://www.python.org/dev/peps/pep-0257/
|
I wanted to link to PEP257 in the document but I couldn't find a good spot for it. Suggestions welcome! |
|
@jni I agree that PEP 257 is worth a link here. Indeed, I realize I should re-read this one, it's been awhile! Thanks for these contributions. Merging. |
amontalenti
added a commit
that referenced
this pull request
Jan 4, 2016
Use present imperative for docstrings
|
Great, nothing like a quickly merged PR to start the day! =D Thanks for a great document. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PEP-257 covers docstring conventions, and has this to say on
the topic: