[New-bugs-announce] [issue22473] The gloss on asyncio "future with run_forever" example is confusing

[R. David Murray]

New submission from R. David Murray:

In https://docs.python.org/3/library/asyncio-task.html#example-future-with-run-forever we have the sentence

  In this example, the future is responsible to display the result and to stop the loop.

We could dune up the English by rewriting it:

  In this example, the future is responsible for displaying the result and stopping the loop.

But that isn't quite true.  It is the callback associated with the future that is displaying the result and stopping the loop.  So, perhaps the correct gloss is:

  In this example, the got_result callback is responsible for displaying the result and stopping the loop.

----------
assignee: docs at python
components: Documentation
messages: 227398
nosy: docs at python, r.david.murray
priority: normal
severity: normal
status: open
title: The gloss on asyncio "future with run_forever" example is confusing
type: behavior
versions: Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue22473>
_______________________________________