﻿id	summary	reporter	owner	description	type	status	component	version	severity	resolution	keywords	cc	stage	has_patch	needs_docs	needs_tests	needs_better_patch	easy	ui_ux
27656	Fix comment verb style according to PEP 257	Anton Samarchyan	Anton Samarchyan	"https://www.python.org/dev/peps/pep-0257/
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 ..."".

It's also mentioned in the django code style.

Example from test/client.py - docstrings from two different functions.
{{{
""""""
Send a TRACE request to the server.
""""""
""""""
Sets the Factory to appear as if it has successfully logged into a site.
""""""
}}}
"	Cleanup/optimization	closed	Core (Other)	dev	Normal	fixed		desecho@…	Accepted	1	0	0	1	1	0
