[issue10385] Mark up "subprocess" as module in its doc
report at bugs.python.org
Fri Nov 12 20:27:36 CET 2010
Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:
On Fri, Nov 12, 2010 at 2:09 PM, Terry J. Reedy <report at bugs.python.org> wrote:
> 1. Does the markup make any visual difference?
It does on my browser. (I wouldn't have noticed it otherwise.) See
> 2. Does the markup affect the index?
I don't think so because module names are already in the index.
This is either holdover or title-case. In either case it should be
fixed. Note that in some section titles it is lower case and marked
> 'Turtle' also appears in several section headers. That could be interpreted
> as a reference to the class rather than the module.
In "Turtle graphics" it is neither -- just part of the name of the
graphics framework. When it is a name of the class, as in " Overview
of available Turtle and Screen methods," is should be marked up with
:class: IMO. In "Tell Turtle’s state", I think "turtle" should be
Python tracker <report at bugs.python.org>
More information about the Python-bugs-list