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.

classification
Title: Please use active voice in async docs.
Type: enhancement Stage:
Components: Documentation Versions: Python 3.10, Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Yury.Selivanov, denilsonsa, docs@python, gvanrossum, terry.reedy
Priority: normal Keywords:

Created on 2020-08-18 09:35 by denilsonsa, last changed 2022-04-11 14:59 by admin.

Messages (2)
msg375603 - (view) Author: Denilson Figueiredo de Sá (denilsonsa) Date: 2020-08-18 09:35
When reading the documentation for call_soon(), call_later(), call_at(), and several other functions, the sentence that describes the return value is in passive voice:
https://docs.python.org/3/library/asyncio-eventloop.html

> An instance of asyncio.TimerHandle is returned which can be used to cancel the callback.

The problem:

Most functions in Python documentation describe the return value by "Return foobar", an active voice sentence at the beginning of a paragraph. (e.g. https://docs.python.org/3/library/functions.html ) Thus, for the reader, it's easy to quickly skim the text for the return value. Even easier because the reader is already trained to do so, given other occurrences in the documentation.

However, by hiding "is returned" in the middle of the sentence/paragraph, the reader can't easily find the return value, having to carefully read through all the text. Not only this is slower, but way more difficult if the reader is in a hurry or tired. (That was my case, I missed that sentence even after looking at the documentation several times.)

Solution:

Change it to: Return an instance of asyncio.TimerHandle which can be used to cancel the callback.

Further solution:

Search the documentation for other cases of "is returned" and consider if it is worth rewording as active voice.

Bonus link: https://developers.google.com/tech-writing/one/active-voice
msg375771 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2020-08-21 22:26
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.
History
Date User Action Args
2022-04-11 14:59:34adminsetgithub: 85747
2020-08-21 22:26:07terry.reedysetnosy: + Yury.Selivanov, gvanrossum, terry.reedy

messages: + msg375771
title: Please use active voice "Return foobar" instead of passive voice "foobar is returned" -> Please use active voice in async docs.
2020-08-18 09:35:22denilsonsacreate