Author eric.araujo
Recipients Kain94, Martijn.van.Oosterhout, amaury.forgeotdarc, belopolsky, collinwinter, eric.araujo, eric.smith, giampaolo.rodola, gvanrossum, pitrou, r.david.murray
Date 2011-07-28.13:57:15
SpamBayes Score 6.24452e-06
Marked as misclassified No
Message-id <1311861437.86.0.559154011263.issue10968@psf.upfronthosting.co.za>
In-reply-to
Content
I’ve committed the cleanup to my 3.3 clone and will push this week.

Here’s a doc patch.  Before my patch, the various classes were documented in two parts: one entry with the factory function (e.g. Thread), without index reference, and one section (e.g. “Thread Objects”), which used a class directive (and thus index target) for most but not all classes.

After my patch, all classes are documented with a class directive, in their section (i.e. “Thread Objects”), with a versionchanged note informing that the name used to be that of a factory function.  The only remaining glitch is that the “X Objects” sections start with a description of the class’ use, which references methods with constructs like :meth:`run`, which cannot be turned into links as Sphinx lacks context: the class directive only happens after.  I could move the class directives right after the heading (“X Objects”), so that the meth roles get turned into links.
History
Date User Action Args
2011-07-28 13:57:18eric.araujosetrecipients: + eric.araujo, gvanrossum, collinwinter, amaury.forgeotdarc, belopolsky, pitrou, eric.smith, giampaolo.rodola, r.david.murray, Kain94, Martijn.van.Oosterhout
2011-07-28 13:57:17eric.araujosetmessageid: <1311861437.86.0.559154011263.issue10968@psf.upfronthosting.co.za>
2011-07-28 13:57:17eric.araujolinkissue10968 messages
2011-07-28 13:57:17eric.araujocreate