This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: documentation for cmd library should include columnize() function
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.11
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, jsiddiqi, sobolevn
Priority: normal Keywords: patch

Created on 2021-12-29 22:35 by jsiddiqi, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 30303 merged sobolevn, 2021-12-30 16:13
Messages (5)
msg409332 - (view) Author: Jawed Siddiqi (jsiddiqi) Date: 2021-12-29 22:35
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
msg409429 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2021-12-31 19:03
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.
msg409509 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2022-01-02 18:33
New changeset ce4d25f3cd0a1c6e65b64015140fb5e1397c8ac5 by Nikita Sobolev in branch 'main':
bpo-46196: document method cmd.Cmd.columnize (#30303)
https://github.com/python/cpython/commit/ce4d25f3cd0a1c6e65b64015140fb5e1397c8ac5
msg409510 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2022-01-02 18:34
Done, cheers!
msg409517 - (view) Author: Jawed Siddiqi (jsiddiqi) Date: 2022-01-02 20:17
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>
> _______________________________________
History
Date User Action Args
2022-04-11 14:59:54adminsetgithub: 90354
2022-01-02 20:17:57jsiddiqisetmessages: + msg409517
2022-01-02 18:34:00eric.araujosetstatus: open -> closed
resolution: fixed
messages: + msg409510

stage: patch review -> resolved
2022-01-02 18:33:28eric.araujosetmessages: + msg409509
2021-12-31 19:03:30eric.araujosettype: enhancement

messages: + msg409429
nosy: + eric.araujo
2021-12-30 16:13:49sobolevnsetkeywords: + patch
nosy: + sobolevn

pull_requests: + pull_request28516
stage: patch review
2021-12-29 22:35:57jsiddiqicreate