classification
Title: Doc typo in asyncio.Task
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, RSChiang, berker.peksag, docs@python, python-dev
Priority: normal Keywords: patch

Created on 2016-10-03 15:59 by RSChiang, last changed 2016-10-04 17:44 by berker.peksag. This issue is now closed.

Files
File name Uploaded Description Edit
issue28348.patch Mariatta, 2016-10-04 03:23 review
Messages (5)
msg277962 - (view) Author: Poren Chiang (RSChiang) Date: 2016-10-03 15:59
Version: Latest (v3.5.2)
Affected module: asyncio (section 18.5)

Problem:
Under section 18.5.3.5. "Task", The word "completion" is misspelled "completition".

> A task is responsible for executing a coroutine object in an event loop. If the wrapped coroutine yields from a future, the task suspends the execution of the wrapped coroutine and waits for the **completition** of the future. When the future is done, the execution of the wrapped coroutine restarts with the result or the exception of the future.

Possible fixes:

Replace "completition" with "completion".

Reference:

[1] https://docs.python.org/3/library/asyncio-task.html#task
msg277966 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2016-10-03 16:34
Thanks for the report. 
Seems like easy fix :)
I'll work on a patch for this today.
msg278006 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2016-10-04 03:23
fixed the typo as reported.
msg278068 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-10-04 17:44
New changeset 8c8692da071a by Berker Peksag in branch '3.5':
Issue #28348: Fix typo in asyncio.Task() documentation
https://hg.python.org/cpython/rev/8c8692da071a

New changeset 99c37fa72b66 by Berker Peksag in branch '3.6':
Issue #28348: Merge from 3.5
https://hg.python.org/cpython/rev/99c37fa72b66

New changeset 76591498aab7 by Berker Peksag in branch 'default':
Issue #28348: Merge from 3.6
https://hg.python.org/cpython/rev/76591498aab7
msg278069 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2016-10-04 17:44
Thanks!
History
Date User Action Args
2016-10-04 17:44:54berker.peksagsetstatus: open -> closed

type: behavior
versions: + Python 3.6, Python 3.7
nosy: + berker.peksag

messages: + msg278069
resolution: fixed
stage: resolved
2016-10-04 17:44:20python-devsetnosy: + python-dev
messages: + msg278068
2016-10-04 03:23:35Mariattasetfiles: + issue28348.patch
keywords: + patch
messages: + msg278006
2016-10-03 16:34:18Mariattasetnosy: + Mariatta
messages: + msg277966
2016-10-03 15:59:10RSChiangcreate