Message 107681 - Python tracker

Message107681

Author	belopolsky
Recipients	belopolsky, docs@python, georg.brandl, mark.dickinson
Date	2010-06-12.18:27:03
SpamBayes Score	0.023600236
Marked as misclassified	No
Message-id	<1276367226.63.0.784666291018.issue8983@psf.upfronthosting.co.za>
In-reply-to

Content
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 ()).

Content

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 ()).

History
Date	User	Action	Args
2010-06-12 18:27:06	belopolsky	set	recipients: + belopolsky, georg.brandl, mark.dickinson, docs@python
2010-06-12 18:27:06	belopolsky	set	messageid: <1276367226.63.0.784666291018.issue8983@psf.upfronthosting.co.za>
2010-06-12 18:27:04	belopolsky	link	issue8983 messages
2010-06-12 18:27:04	belopolsky	create