Changed summary line of docstring to follow PEP 0257 - #691
Merged
kennethreitz merged 2 commits intoMar 24, 2016
Merged
kennethreitz merged 2 commits into
kennethreitz merged 2 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Quoting https://www.python.org/dev/peps/pep-0257/#one-line-docstrings 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 ...".
Quoting https://www.python.org/dev/peps/pep-0257/#one-line-docstrings "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 ...".
Copy link
Copy Markdown
Contributor
|
✨ 🍰 ✨ |
Sorry, something went wrong.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Quoting https://www.python.org/dev/peps/pep-0257/#one-line-docstrings