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

orsenthil · orsenthil · commit ebd84e342c83 · 2016-05-29T20:36:58.000-07:00
Patch contributed by Nathan Harold.
diff --git 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:
