[docs] [issue8983] Docstrings should refer to help(name), not name.__doc__
Alexander Belopolsky
report at bugs.python.org
Sat Jun 12 20:27:06 CEST 2010
Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:
Attaching issue8983.diff patch. I am a bit unsure about __init__ docstring change:
1. Are cases when help(type(x)) differs from help(x) important enough to distinguish in docstring?
2. Do we need a default docstring on __init__ at all? If so, should we keep a reference to class doc which may not be correct? See issue8973.
3. Why __init__ has a default docstring but __new__ and __del__ don't?
4. There are some other inconsistencies in type docstrings. E.g., "__subclasschck__ -> check if an class is a subclass" (misspelling and and missing ()).
----------
keywords: +patch
stage: needs patch -> commit review
versions: +Python 2.7, Python 3.2
Added file: http://bugs.python.org/file17647/issue8983.diff
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8983>
_______________________________________
More information about the docs
mailing list