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 50d59e11565357592d92cc293aa322945f8fde92..1964f7145ebc2c9c86f355b6466db151df037048 100644 (file)
--- 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