Changes by Arfrever Frehtes Taifersar Arahesis arfrever@gmail.com:
--
nosy: +Arfrever
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16568
___
Changes by Terry J. Reedy tjre...@udel.edu:
--
nosy: +terry.reedy
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16568
___
___
Python-bugs-list
New submission from Chris Jerdonek:
This issue is to settle on and provide a way to document the constructor of a
class separately from the overall summary/description of a class.
This is something that Ezio, Nick, and I discussed briefly on IRC a few hours
ago. We all see the value in it.
Ezio Melotti added the comment:
I was wondering if this should be called initializer instead of constructor.
Another idea is to keep using the method directive and use :initializer: to
differentiate it from the others. This might be easier to implement, but OTOH
is not consistent with the
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
nosy: +georg.brandl
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16568
___
___
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
nosy: +eric.araujo
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16568
___
___
Python-bugs-list
É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
Ezio Melotti added the comment:
This came up while documenting the str type in datamodel.rst (IIRC), and
linking to it from functions.rst.
On one hand you want to say what the str type is, on the other hand you want to
document the constructor and explain how can you use str() to obtain str
Éric Araujo added the comment:
For all the built-in types, I see the value now.
Thinking aloud: Separating the namespaces used by the str and func roles would
probably require too many changes in Sphinx.
The current way is to use the function directive to document the
class/constructor usage
Ezio Melotti added the comment:
For all the built-in types, I see the value now.
The same applies for non built-in types too though (e.g.
http://docs.python.org/3.4/library/collections.html). The only difference is
that the built-in ones have entries in functions.rst and use more links.
10 matches
Mail list logo
