Skip to content

Fixed example docstring#752

Merged
kennethreitz merged 1 commit into
realpython:masterfrom
sidney-pham:master
Oct 31, 2016
Merged

Fixed example docstring#752
kennethreitz merged 1 commit into
realpython:masterfrom
sidney-pham:master

Conversation

@sidney-pham

Copy link
Copy Markdown

PEP 257 says:

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 ...".

@kennethreitz kennethreitz merged commit ef26c66 into realpython:master Oct 31, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants