This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author eric.araujo
Recipients chris.jerdonek, docs@python, eric.araujo, ezio.melotti, georg.brandl, ncoghlan
Date 2012-11-29.03:42:13
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1354160534.45.0.570200548261.issue16568@psf.upfronthosting.co.za>
In-reply-to
Content
I’m interested in an explanation of the value of doing this.

In the threading docs for example, the classes (i.e. initializers) are documented in one section, with awkward links to “Thread objects”, “Lock objects”, etc.  This felt much more cumbersome to me than more modern class/attribute/method combos.  Isn’t it the simplest thing to document one class, usage, constructors and all attributes, in one place?

On the other hand, I don’t have the view of an outsider anymore, so I can’t say what makes sense / reads better for the doc’s audience (as opposed to doc editors).
History
Date User Action Args
2012-11-29 03:42:14eric.araujosetrecipients: + eric.araujo, georg.brandl, ncoghlan, ezio.melotti, chris.jerdonek, docs@python
2012-11-29 03:42:14eric.araujosetmessageid: <1354160534.45.0.570200548261.issue16568@psf.upfronthosting.co.za>
2012-11-29 03:42:14eric.araujolinkissue16568 messages
2012-11-29 03:42:13eric.araujocreate