Skip to content

Commit

Permalink
Changed summary line of docstring to follow PEP 0257
Browse files Browse the repository at this point in the history
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 ...".
  • Loading branch information
remcodraijer committed Mar 24, 2016
1 parent 9ddb9ab commit 6b4d013
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/writing/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ A simple doctest in a function:
.. code-block:: python
def square(x):
"""Squares x.
"""Square x.
>>> square(2)
4
Expand Down

0 comments on commit 6b4d013

Please sign in to comment.