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

Documentation for Queue in 2.x has an incorrect title #56783

Closed
rafekettler mannequin opened this issue Jul 15, 2011 · 4 comments
Closed

Documentation for Queue in 2.x has an incorrect title #56783

rafekettler mannequin opened this issue Jul 15, 2011 · 4 comments
Labels
docs Documentation in the Doc dir

Comments

@rafekettler
Copy link
Mannequin

rafekettler mannequin commented Jul 15, 2011

BPO 12574
Files
  • unnamed
  • queue_docs.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 2011-07-17.02:56:59.416>
    created_at = <Date 2011-07-15.23:25:48.303>
    labels = ['docs']
    title = 'Documentation for Queue in 2.x has an incorrect title'
    updated_at = <Date 2011-07-17.02:56:59.415>
    user = 'https://bugs.python.org/rafekettler'

    bugs.python.org fields:

    activity = <Date 2011-07-17.02:56:59.415>
    actor = 'eli.bendersky'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2011-07-17.02:56:59.416>
    closer = 'eli.bendersky'
    components = ['Documentation']
    creation = <Date 2011-07-15.23:25:48.303>
    creator = 'rafe.kettler'
    dependencies = []
    files = ['22676', '22677']
    hgrepos = []
    issue_num = 12574
    keywords = ['patch']
    message_count = 4.0
    messages = ['140475', '140497', '140503', '140515']
    nosy_count = 4.0
    nosy_names = ['eli.bendersky', 'docs@python', 'rafe.kettler', 'python-dev']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = None
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue12574'
    versions = ['Python 2.6', 'Python 2.7']

    @rafekettler
    Copy link
    Mannequin Author

    rafekettler mannequin commented Jul 15, 2011

    The documentation for Queue in all versions of Python 2.7 and 2.6 (see http://docs.python.org/release/2.6.7/library/queue.html#module-Queue for the 2.7 docs) has the title "queue -- A synchronized queue class." The module, however, is named "Queue" in all of 2.x. So, while the title is appropiate for 3.x, it's incorrect for 2.x.

    I can make a patch, as well.

    @rafekettler rafekettler mannequin assigned docspython Jul 15, 2011
    @rafekettler rafekettler mannequin added the docs Documentation in the Doc dir label Jul 15, 2011
    @elibendersky
    Copy link
    Mannequin

    elibendersky mannequin commented Jul 16, 2011

    The documentation for Queue in all versions of Python 2.7 and 2.6 (see
    http://docs.python.org/release/2.6.7/library/queue.html#module-Queue for
    the 2.7 docs) has the title "queue -- A synchronized queue class." The
    module, however, is named "Queue" in all of 2.x. So, while the title is
    appropiate for 3.x, it's incorrect for 2.x.

    I can make a patch, as well.

    Sure, make a patch for 2.7 (the 2.6 line is now in "security only" mode).

    Eli

    @rafekettler
    Copy link
    Mannequin Author

    rafekettler mannequin commented Jul 16, 2011

    Okay, here's a patch.

    I also went ahead and added my name to ACKS, since this is my 3rd or 4th patch.

    Rafe

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jul 17, 2011

    New changeset 60ce5f279a5e by Eli Bendersky in branch '2.7':
    Issue bpo-12574: correct capitalization of the Queue module. Patch by Rafe Kettler
    http://hg.python.org/cpython/rev/60ce5f279a5e

    @elibendersky elibendersky mannequin closed this as completed Jul 17, 2011
    @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