[issue12916] Add inspect.splitdoc

Eric Snow report at bugs.python.org
Wed Apr 16 16:11:08 CEST 2014


Eric Snow added the comment:

I agree with Éric that exposing splidoc publicly in the inspect module is the right thing.  inspect already has other similar functions.  If it doesn't land in inspect then the only other place that makes real sense to me would be a new module (docstring?).  However, that seems like overkill to me.

Furthermore, pydoc doesn't seem like a good place to expose the function (or perhaps any function <wink>).  It isn't a module relating explicitly to docstrings so much as to exposing API documentation.  The use of splitdoc there is an implementation detail while splitdoc itself is generally useful.  That said, I would still expect splitdoc to be exposed in pydoc for backward compatibility (via "from inspect import splitdoc").

----------
nosy: +eric.snow

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12916>
_______________________________________


More information about the Python-bugs-list mailing list