✕
Skip to content

Cancel method for Asyncio Task is not documented #65800

Closed

Description

@vajrasky
mannequin
BPO 21601
Nosy @gvanrossum, @pitrou, @vstinner, @giampaolo, @1st1, @vajrasky
Files
  • fix_doc_asyncio_task.patch
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = <Date 2014-06-02.21:10:15.358>
    created_at = <Date 2014-05-29.05:08:32.266>
    labels = ['docs']
    title = 'Cancel method for Asyncio Task is not documented'
    updated_at = <Date 2014-06-02.21:10:15.355>
    user = 'https://github.com/vajrasky'

    bugs.python.org fields:

    activity = <Date 2014-06-02.21:10:15.355>
    actor = 'vstinner'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2014-06-02.21:10:15.358>
    closer = 'vstinner'
    components = ['Documentation']
    creation = <Date 2014-05-29.05:08:32.266>
    creator = 'vajrasky'
    dependencies = []
    files = ['35397']
    hgrepos = []
    issue_num = 21601
    keywords = ['patch']
    message_count = 3.0
    messages = ['219333', '219641', '219642']
    nosy_count = 8.0
    nosy_names = ['gvanrossum', 'pitrou', 'vstinner', 'giampaolo.rodola', 'docs@python', 'python-dev', 'yselivanov', 'vajrasky']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = None
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue21601'
    versions = ['Python 3.4', 'Python 3.5']

    Activity

    1. vajrasky commented on May 29, 2014

      vajraskymannequin
      MannequinAuthor

      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.

    2. python-dev commented on Jun 2, 2014

      python-devmannequin
      Mannequin

      New changeset c2384ca7fc3b by Victor Stinner in branch '3.4':
      Issue bpo-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 bpo-21601: Document asyncio.Task.cancel(). Initial patch written
      http://hg.python.org/cpython/rev/0ee47d3d2664

    3. vstinner commented on Jun 2, 2014

      @vstinner
      Member

      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.

    4. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      docsDocumentation in the Doc dir

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions