➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author bignose
Recipients bignose, docs@python
Date 2016-05-17.00:42:36
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1463445757.83.0.886794484792.issue27043@psf.upfronthosting.co.za>
In-reply-to
Content 
The library documentation for ‘inspect.cleandoc’ describes the transformation that occurs to “the second line onwards”, but makes no mention of what processing occurs to the synopsis (first) line.

Please update the library documentation for this function, to explicitly describe how it processes each of the different parts of a docstring.

If possible, this should be guided by PEP 257's discussion of how indentation is transformed: https://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation
History
Date User Action Args
2016-05-17 00:42:37bignosesetrecipients: + bignose, docs@python
2016-05-17 00:42:37bignosesetmessageid: <1463445757.83.0.886794484792.issue27043@psf.upfronthosting.co.za>
2016-05-17 00:42:37bignoselinkissue27043 messages
2016-05-17 00:42:36bignosecreate