Changed summary line of docstring to follow PEP 0257 - update

remcodraijer · remcodraijer · commit 02d68a86ed9a · 2016-03-24T12:33:39.000+01:00
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 ...".
diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst
@@ -116,7 +116,7 @@ A simple doctest in a function:
 .. code-block:: python
 
     def square(x):
-        """Square x.
+        """Return the square of x.
 
         >>> square(2)
         4

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ A simple doctest in a function:`
`116`	`116`	`.. code-block:: python`
`117`	`117`
`118`	`118`	`def square(x):`
`119`		`- """Square x.`
	`119`	`+ """Return the square of x.`
`120`	`120`
`121`	`121`	`>>> square(2)`
`122`	`122`	`4`