issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.

Patch contributed by Nathan Harold.

issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.
Patch contributed by Nathan Harold.
ebd84e34 · Senthil Kumaran · 8d56c026 · ebd84e34
Kaydet (Commit) ebd84e34 authored May 30, 2016 tarafından Senthil Kumaran
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 2 deletions

inspect.rst Doc/library/inspect.rst +6 -2

No files found.
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -489,8 +489,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.


 .. _inspect-signature-object: