[issue41575] Please use active voice in async docs.
Terry J. Reedy
report at bugs.python.org
Fri Aug 21 18:26:07 EDT 2020
Terry J. Reedy <tjreedy at udel.edu> added the comment:
Active voice is strongly recommended for docstrings in PEP 257 and commit messages somewhere in the Developer guide and applies to docs. The doc for the asyncio call_x functions all start with the active voice: 'Schedule', which is the main action of the function. 'is returned' occurs later in the entries and that case is less clear.
----------
nosy: +Yury.Selivanov, gvanrossum, terry.reedy
title: Please use active voice "Return foobar" instead of passive voice "foobar is returned" -> Please use active voice in async docs.
_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue41575>
_______________________________________
More information about the Python-bugs-list
mailing list