New submission from Ben Finney:

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

----------
assignee: docs@python
components: Documentation
messages: 265741
nosy: bignose, docs@python
priority: normal
severity: normal
status: open
title: Describe what ‘inspect.cleandoc’ does to synopsis line.
type: enhancement
versions: Python 2.7, Python 3.6

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue27043>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to