[issue10968] threading.Timer should be a class so that it can be derived

Éric Araujo report at bugs.python.org
Thu Jul 28 15:57:17 CEST 2011


Éric Araujo <merwok at netwok.org> added the comment:

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.

----------
assignee:  -> eric.araujo
Added file: http://bugs.python.org/file22784/threading-3.3-doc.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10968>
_______________________________________


More information about the Python-bugs-list mailing list