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 ezio.melotti
Recipients chris.jerdonek, docs@python, eric.araujo, ezio.melotti, georg.brandl, ncoghlan
Date 2012-11-29.03:53:23
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1354161204.05.0.478252415033.issue16568@psf.upfronthosting.co.za>
In-reply-to
Content
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 objects.
Putting both under the constructor doesn't work too well, especially when there's a lot of text.  Putting the str type description in a plain paragraph before the "class" directive doesn't work too well either, because :class:`str` will link to the constructor documentation.

The idea is to keep the two separate but still provide an easy way to link to the class without missing the general description.
History
Date User Action Args
2012-11-29 03:53:24ezio.melottisetrecipients: + ezio.melotti, georg.brandl, ncoghlan, eric.araujo, chris.jerdonek, docs@python
2012-11-29 03:53:24ezio.melottisetmessageid: <1354161204.05.0.478252415033.issue16568@psf.upfronthosting.co.za>
2012-11-29 03:53:24ezio.melottilinkissue16568 messages
2012-11-29 03:53:23ezio.melotticreate