Roundup Robot added the comment:
New changeset 58564aeec8e4 by Ezio Melotti in branch '2.7':
#10385: use the mod role in subprocess docs.
http://hg.python.org/cpython/rev/58564aeec8e4
New changeset 8e8d391eb3eb by Ezio Melotti in branch '3.2':
#10385: use the mod role in subprocess docs.
Ezio Melotti added the comment:
It looked OK and the :mod: role was already used throughout the page, so I
applied the patch.
--
assignee: belopolsky - ezio.melotti
resolution: - fixed
stage: commit review - committed/rejected
status: open - closed
type: - enhancement
versions:
Terry J. Reedy tjre...@udel.edu added the comment:
1. Does the markup make any visual difference?
2. Does the markup affect the index?
3. What do other module docs do?
I notice that 'Tkinter' appears in several section headings. Is it marked? (Is
the upper case a holdover that should be
Alexander Belopolsky belopol...@users.sourceforge.net added the comment:
On Fri, Nov 12, 2010 at 2:09 PM, Terry J. Reedy rep...@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
Georg Brandl ge...@python.org added the comment:
Eric: any :mod: role never affects the index. Only the module directive does.
Otherwise, I concur that it's not mandatory to mark up every occurrence of the
module name, but it's nice in section headings.
--
Terry J. Reedy tjre...@udel.edu added the comment:
http://docs.python.org/dev/contents.html
The only thing I see there is the bold-facing of *PEP 3101*.
Is that what you are referring to?
In any case, with Georg's concurrence go ahead with this and any other modules
you care about.
--
Ezio Melotti ezio.melo...@gmail.com added the comment:
I think that using e.g. :mod:`subprocess` in the subprocess page is redundant
because there's no need to add a link to the page you are already reading. I'm
also not sure that it looks too nice in the headers (iirc the font is
different),
New submission from Alexander Belopolsky belopol...@users.sourceforge.net:
I was going to commit this patch, but decided to ask for a second opinion. I
think module names in section titles should be marked up with :mod:.
--
assignee: belopolsky
components: Documentation
files:
Éric Araujo mer...@netwok.org added the comment:
Marking up each and every instance of a module name is not mandatory IMO.
What’s important is that each document title starts with the :mod: construct,
so that the HTML titles and index (at /library) be consistently useful. See
for example
