From: Senthil Kumaran Date: Mon, 30 May 2016 03:38:55 +0000 (-0700) Subject: issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines. X-Git-Tag: v2.7.12rc1~40 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=739b3737f249acb3f4772b732fca2180717cbcba;p=thirdparty%2FPython%2Fcpython.git issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines. Patch contributed by Nathan Harold. --- diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index 50d59e115653..1964f7145ebc 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -443,8 +443,12 @@ Retrieving source code .. function:: cleandoc(doc) Clean up indentation from docstrings that are indented to line up with blocks - of code. Any whitespace that can be uniformly removed from the second line - onwards is removed. Also, all tabs are expanded to spaces. + of code. + + All leading whitespace is removed from the first line. Any leading whitespace + that can be uniformly removed from the second line onwards is removed. Empty + lines at the beginning and end are subsequently removed. Also, all tabs are + expanded to spaces. .. versionadded:: 2.6