From: Filip Łapkiewicz <80906036+fipachu@users.noreply.github.com>
Date: Wed, 3 Jan 2024 19:37:34 +0000 (+0100)
Subject: gh-52161: Enhance Cmd support for docstrings (#110987)
X-Git-Tag: v3.13.0a3~190
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4c4b08dd2bd5f2cad4e41bf29119a3daa2956f6e;p=thirdparty%2FPython%2Fcpython.git

gh-52161: Enhance Cmd support for docstrings (#110987)

In `cmd.Cmd.do_help` call `inspect.cleandoc()`,
to clean indentation and remove leading/trailing empty
lines from a dosctring before printing.
---

diff --git a/Lib/cmd.py b/Lib/cmd.py
index 2e358d6cd5a0..a37d16cd7bde 100644
--- a/Lib/cmd.py
+++ b/Lib/cmd.py
@@ -42,7 +42,7 @@ listings of documented functions, miscellaneous topics, and undocumented
 functions respectively.
 """
 
-import string, sys
+import inspect, string, sys
 
 __all__ = ["Cmd"]
 
@@ -305,6 +305,7 @@ class Cmd:
             except AttributeError:
                 try:
                     doc=getattr(self, 'do_' + arg).__doc__
+                    doc = inspect.cleandoc(doc)
                     if doc:
                         self.stdout.write("%s\n"%str(doc))
                         return
diff --git a/Misc/NEWS.d/next/Library/2023-10-17-16-11-03.gh-issue-52161.WBYyCJ.rst b/Misc/NEWS.d/next/Library/2023-10-17-16-11-03.gh-issue-52161.WBYyCJ.rst
new file mode 100644
index 000000000000..3f598d40e4ae
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2023-10-17-16-11-03.gh-issue-52161.WBYyCJ.rst
@@ -0,0 +1,2 @@
+:meth:`cmd.Cmd.do_help` now cleans docstrings with :func:`inspect.cleandoc`
+before writing them. Patch by Filip Łapkiewicz.