[docs] [issue15569] Doc doc: incorrect description of some roles as format-only

Terry J. Reedy report at bugs.python.org
Fri Apr 25 05:58:20 CEST 2014


Terry J. Reedy added the comment:

There are no versions for the devguide. There is another misplaced role:
:
option
    A command-line option of Python. The leading hyphen(s) must be included. If a matching cmdoption directive exists, it is linked to. For options of other programs or scripts, use simple ``code`` markup.

I think "The following role does possibly create a cross-reference, but does not refer to objects:" should be changed to something like "The following roles do not refer to module objects, but possibly create cross-references or internal links:". Move the three misplaced roles here, along with token and term.

----------
nosy: +terry.reedy
versions:  -Python 2.7, Python 3.2, Python 3.3, Python 3.4

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


More information about the docs mailing list