Changed summary line of docstring to follow PEP 0257

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 ...".
This commit is contained in:
remcodraijer
2016-03-24 12:27:57 +01:00
parent 9ddb9ab3ba
commit 6b4d013f52
+1 -1
View File
@@ -116,7 +116,7 @@ A simple doctest in a function:
.. code-block:: python
def square(x):
"""Squares x.
"""Square x.
>>> square(2)
4