[docs] [issue16568] allow constructors to be documented separately from class

Éric Araujo report at bugs.python.org
Thu Nov 29 04:42:14 CET 2012

Éric Araujo added the comment:

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


Python tracker <report at bugs.python.org>

More information about the docs mailing list