classification
Title: Cancel method for Asyncio Task is not documented
Type: Stage:
Components: Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, giampaolo.rodola, gvanrossum, pitrou, python-dev, vajrasky, vstinner, yselivanov
Priority: normal Keywords: patch

Created on 2014-05-29 05:08 by vajrasky, last changed 2014-06-02 21:10 by vstinner. This issue is now closed.

Files
File name Uploaded Description Edit
fix_doc_asyncio_task.patch vajrasky, 2014-05-29 05:08 review
Messages (3)
msg219333 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2014-05-29 05:08
https://docs.python.org/3.5/library/asyncio-task.html#task

The cancel method is not documented although it is a part of public API. Here is the patch to fix the doc.
msg219641 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-06-02 21:09
New changeset c2384ca7fc3b by Victor Stinner in branch '3.4':
Issue #21601: Document asyncio.Task.cancel(). Initial patch written by Vajrasky
http://hg.python.org/cpython/rev/c2384ca7fc3b

New changeset 0ee47d3d2664 by Victor Stinner in branch 'default':
(Merge 3.4) Issue #21601: Document asyncio.Task.cancel(). Initial patch written
http://hg.python.org/cpython/rev/0ee47d3d2664
msg219642 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2014-06-02 21:10
Thanks for the patch.

By the way, the CancelledError from conccurent.futures is not documented and asyncio still has its own asyncio.CancelledError alias which is not documented neither.
History
Date User Action Args
2014-06-02 21:10:15vstinnersetstatus: open -> closed

nosy: + gvanrossum, pitrou, giampaolo.rodola, yselivanov
messages: + msg219642

resolution: fixed
2014-06-02 21:09:05python-devsetnosy: + python-dev
messages: + msg219641
2014-05-29 05:08:32vajraskycreate