[New-bugs-announce] [issue9312] Fix usage of :option: markup in stdlib ReST docs

Eli Bendersky report at bugs.python.org
Tue Jul 20 06:19:47 CEST 2010

New submission from Eli Bendersky <eliben at gmail.com>:

Due to a discussion on python-dev (Subject: "Markup of command-line options in Python's .rst documentation"), Georg Brandl checked in revision r82961 with a clarification of :option: markup which should only be used for Python interpreter's own flags.

However, several modules in stdlib use :option: for their own command-line options, which creates confusion (these options get linked by Sphinx to unrelated Python options).

I'm attaching a patch that fixes this issue for these files. The affected files are:


Note1: :option: was fixed to `` markup (code snippet) as per the recommendation in the updated documentation guide
Note2: I didn't patch trace.rst because it's overgoing a major rehaul (http://bugs.python.org/issue9264)

assignee: docs at python
components: Documentation
messages: 110862
nosy: docs at python, eli.bendersky
priority: normal
severity: normal
status: open
title: Fix usage of :option: markup in stdlib ReST docs
type: behavior
versions: Python 3.2

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list