[New-bugs-announce] [issue47207] Switch datetime docstrings / documentation to using "Returns" rather than "Return"?

[Paul Ganssle]

New submission from Paul Ganssle <bpo at m.ganssle.io>:

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.

----------
assignee: docs at python
components: Documentation
messages: 416628
nosy: belopolsky, docs at python, fdrake, p-ganssle, slateny
priority: normal
severity: normal
status: open
title: Switch datetime docstrings / documentation to using "Returns" rather than "Return"?
versions: Python 3.11

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue47207>
_______________________________________