mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 19:34:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

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

Browse source 
Patch contributed by Nathan Harold.
This commit is contained in:
Senthil Kumaran 2016-05-29 20:36:58 -07:00
parent 8d56c026a5
commit ebd84e342c
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/inspect.rst
View file

@ -489,8 +489,12 @@ Retrieving source code
.. function:: cleandoc(doc) .. function:: cleandoc(doc)
Clean up indentation from docstrings that are indented to line up with blocks 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 of code.
onwards is removed. Also, all tabs are expanded to spaces.
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: .. _inspect-signature-object: