Changed summary line of docstring to follow PEP 0257 - update · realpython/python-guide@02d68a8 · GitHub

realpython / python-guide Public

• Notifications You must be signed in to change notification settings
• Fork 5.9k
• Star 29.8k

• Code
• Issues 104
• Pull requests 32
• Actions
• Projects
• Wiki
• Security and quality
• Insights

Additional navigation options

Commit 02d68a8

Browse filesBrowse the repository at this point in the historyBrowse files

remcodraijer

committed

Changed summary line of docstring to follow PEP 0257 - update

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

1 parent 6b4d013 commit 02d68a8
Copy full SHA for 02d68a8

1 file changed

+1-1Lines changed: 1 addition & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• docs/writing
  • tests.rst

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎docs/writing/tests.rst‎

Copy file name to clipboardExpand all lines: docs/writing/tests.rst

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

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

0 commit comments

Comments

0 (0)