Commit 96ebb843 authored by Senthil Kumaran's avatar Senthil Kumaran

[merge from 3.5] issue27043 - Explain the inspect.cleandoc behavior on...

[merge from 3.5] issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.

Patch contributed by Nathan Harold.
parents eb6cd742 ebd84e34
......@@ -470,8 +470,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:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment