Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading word used for __annotations__ #64309

Closed
PCManticore mannequin opened this issue Jan 2, 2014 · 2 comments
Closed

Misleading word used for __annotations__ #64309

PCManticore mannequin opened this issue Jan 2, 2014 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@PCManticore
Copy link
Mannequin

PCManticore mannequin commented Jan 2, 2014

BPO 20110
Nosy @PCManticore
Files
  • doc_annotation.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-01-02.22:48:38.849>
    created_at = <Date 2014-01-02.19:41:53.816>
    labels = ['docs']
    title = 'Misleading word used for __annotations__'
    updated_at = <Date 2014-01-02.22:48:38.848>
    user = 'https://github.com/PCManticore'

    bugs.python.org fields:

    activity = <Date 2014-01-02.22:48:38.848>
    actor = 'python-dev'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2014-01-02.22:48:38.849>
    closer = 'python-dev'
    components = ['Documentation']
    creation = <Date 2014-01-02.19:41:53.816>
    creator = 'Claudiu.Popa'
    dependencies = []
    files = ['33297']
    hgrepos = []
    issue_num = 20110
    keywords = ['patch']
    message_count = 2.0
    messages = ['207183', '207195']
    nosy_count = 3.0
    nosy_names = ['docs@python', 'Claudiu.Popa', 'python-dev']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue20110'
    versions = ['Python 3.4']

    @PCManticore
    Copy link
    Mannequin Author

    PCManticore mannequin commented Jan 2, 2014

    The documentation for __annotations__ specify that the dict contains the parameter names or the return, but this is misleading, because return exists even if the parameter keys are present.

    @PCManticore PCManticore mannequin assigned docspython Jan 2, 2014
    @PCManticore PCManticore mannequin added the docs Documentation in the Doc dir label Jan 2, 2014
    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jan 2, 2014

    New changeset 203ca77ea819 by Benjamin Peterson in branch '3.3':
    correct word for __annotations__ doc (closes bpo-20110)
    http://hg.python.org/cpython/rev/203ca77ea819

    New changeset 3e75f649e93b by Benjamin Peterson in branch 'default':
    merge 3.3 (bpo-20110)
    http://hg.python.org/cpython/rev/3e75f649e93b

    @python-dev python-dev mannequin closed this as completed Jan 2, 2014
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    0 participants