Message 416628 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	p-ganssle
Recipients	belopolsky, docs@python, fdrake, p-ganssle, slateny
Date	2022-04-03.16:08:24
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1649002105.09.0.287178375758.issue47207@roundup.psfhosted.org>
In-reply-to

Content
In bpo-9305, Fred Drake recommends preferring `Returns ...` over the imperative `Return ...`: https://bugs.python.org/issue9305#msg110912 Currently we're pretty consistent about `Return ...`, which is consistent with PEP 257: https://peps.python.org/pep-0257/ That said, I actually think "Returns ..." sounds much better in the documentation, and I'd be happy to see it changed if others agree. I have spun this off from bpo-9305 so that we can unblock https://github.com/python/cpython/pull/31697.

In bpo-9305, Fred Drake recommends preferring `Returns ...` over the imperative `Return ...`: https://bugs.python.org/issue9305#msg110912

Currently we're pretty consistent about `Return ...`, which is consistent with PEP 257: https://peps.python.org/pep-0257/

That said, I actually think "Returns ..." sounds much better in the documentation, and I'd be happy to see it changed if others agree.

I have spun this off from bpo-9305 so that we can unblock https://github.com/python/cpython/pull/31697.

History
Date	User	Action	Args
2022-04-03 16:08:25	p-ganssle	set	recipients: + p-ganssle, fdrake, belopolsky, docs@python, slateny
2022-04-03 16:08:25	p-ganssle	set	messageid: <1649002105.09.0.287178375758.issue47207@roundup.psfhosted.org>
2022-04-03 16:08:25	p-ganssle	link	issue47207 messages
2022-04-03 16:08:24	p-ganssle	create