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 cmd library should include columnize() function #90354

Closed
jsiddiqi mannequin opened this issue Dec 29, 2021 · 5 comments
Closed

documentation for cmd library should include columnize() function #90354

jsiddiqi mannequin opened this issue Dec 29, 2021 · 5 comments
Labels
3.11 bug and security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@jsiddiqi
Copy link
Mannequin

jsiddiqi mannequin commented Dec 29, 2021

BPO 46196
Nosy @merwok, @sobolevn
PRs
  • bpo-46196: document method cmd.Cmd.columnize #30303
  • 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 2022-01-02.18:34:00.715>
    created_at = <Date 2021-12-29.22:35:57.659>
    labels = ['3.11', 'type-feature', 'docs']
    title = 'documentation for cmd library should include columnize() function'
    updated_at = <Date 2022-01-02.20:17:57.074>
    user = 'https://bugs.python.org/jsiddiqi'

    bugs.python.org fields:

    activity = <Date 2022-01-02.20:17:57.074>
    actor = 'jsiddiqi'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2022-01-02.18:34:00.715>
    closer = 'eric.araujo'
    components = ['Documentation']
    creation = <Date 2021-12-29.22:35:57.659>
    creator = 'jsiddiqi'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 46196
    keywords = ['patch']
    message_count = 5.0
    messages = ['409332', '409429', '409509', '409510', '409517']
    nosy_count = 4.0
    nosy_names = ['eric.araujo', 'docs@python', 'sobolevn', 'jsiddiqi']
    pr_nums = ['30303']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue46196'
    versions = ['Python 3.11']

    @jsiddiqi
    Copy link
    Mannequin Author

    jsiddiqi mannequin commented Dec 29, 2021

    Cmd.columnize is an extremely useful function in Python, that can be used in many situations. It is part of the Cmd library. Unfortunately, the Cmd documentation does not mention it. It should. I only found out about it via https://stackoverflow.com/a/59627245

    Please add to the documentation: https://docs.python.org/3/library/cmd.html

    @jsiddiqi jsiddiqi mannequin added the 3.11 bug and security fixes label Dec 29, 2021
    @jsiddiqi jsiddiqi mannequin assigned docspython Dec 29, 2021
    @jsiddiqi jsiddiqi mannequin added docs Documentation in the Doc dir 3.11 bug and security fixes labels Dec 29, 2021
    @jsiddiqi jsiddiqi mannequin assigned docspython Dec 29, 2021
    @jsiddiqi jsiddiqi mannequin added the docs Documentation in the Doc dir label Dec 29, 2021
    @merwok
    Copy link
    Member

    merwok commented Dec 31, 2021

    The method is called from one place only, but the fact that it is its own method and has dedicated tests seems to indicate that it was meant as standalone piece of functionality. We can’t be sure of original intent given that no method in the class uses the _ prefix naming convention, but I think it’s fine to document the function and so make it officially public now.

    @merwok merwok added type-feature A feature request or enhancement labels Dec 31, 2021
    @merwok
    Copy link
    Member

    merwok commented Jan 2, 2022

    New changeset ce4d25f by Nikita Sobolev in branch 'main':
    bpo-46196: document method cmd.Cmd.columnize (bpo-30303)
    ce4d25f

    @merwok
    Copy link
    Member

    merwok commented Jan 2, 2022

    Done, cheers!

    @merwok merwok closed this as completed Jan 2, 2022
    @merwok merwok closed this as completed Jan 2, 2022
    @jsiddiqi
    Copy link
    Mannequin Author

    jsiddiqi mannequin commented Jan 2, 2022

    Thank you!

    Jawed

    On Jan 2, 2022, at 10:34 AM, Éric Araujo <report@bugs.python.org> wrote:

    Éric Araujo <merwok@netwok.org> added the comment:

    Done, cheers!

    ----------
    resolution: -> fixed
    stage: patch review -> resolved
    status: open -> closed


    Python tracker <report@bugs.python.org>
    <https://bugs.python.org/issue46196\>


    @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
    3.11 bug and security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant