From: Nikita Sobolev <mail@sobolevn.me>
Date: Sun, 2 Jan 2022 18:33:20 +0000 (+0300)
Subject: bpo-46196: document method cmd.Cmd.columnize (#30303)
X-Git-Tag: v3.11.0a4~110
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ce4d25f3cd0a1c6e65b64015140fb5e1397c8ac5;p=thirdparty%2FPython%2Fcpython.git

bpo-46196: document method cmd.Cmd.columnize (#30303)

The method is already written and tested, now it's officially public.
---

diff --git a/Doc/library/cmd.rst b/Doc/library/cmd.rst
index d57edb7eb169..fd5df96dfd0b 100644
--- a/Doc/library/cmd.rst
+++ b/Doc/library/cmd.rst
@@ -121,6 +121,13 @@ A :class:`Cmd` instance has the following methods:
    :meth:`complete_\*` method is available.  By default, it returns an empty list.
 
 
+.. method:: Cmd.columnize(list, displaywidth=80)
+
+   Method called to display a list of strings as a compact set of columns.
+   Each column is only as wide as necessary.
+   Columns are separated by two spaces for readability.
+
+
 .. method:: Cmd.precmd(line)
 
    Hook method executed just before the command line *line* is interpreted, but
diff --git a/Misc/NEWS.d/next/Documentation/2021-12-30-19-12-24.bpo-46196.UvQ8Sq.rst b/Misc/NEWS.d/next/Documentation/2021-12-30-19-12-24.bpo-46196.UvQ8Sq.rst
new file mode 100644
index 000000000000..f14ada607522
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-12-30-19-12-24.bpo-46196.UvQ8Sq.rst
@@ -0,0 +1 @@
+Document method :meth:`cmd.Cmd.columnize`.