[docs] [issue8983] Docstrings should refer to help(name), not name.__doc__

Alexander Belopolsky report at bugs.python.org
Sat Jun 12 17:32:06 CEST 2010


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

A couple more:

$ grep -in "see.*\.__doc__" Lib/*.py
Lib/doctest.py:1782:    See doctest.__doc__ for an overview.
Lib/inspect.py:162:    See isfunction.__doc__ for attributes listing."""

an a really problematic

Objects/typeobject.c:5529:           "see x.__class__.__doc__ for signature",

This  affects every class' help and is very confusing when class doecstring does not show the constructor signature.

----------

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


More information about the docs mailing list