This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author chris.jerdonek
Recipients chris.jerdonek, ezio.melotti
Date 2012-08-07.01:24:05
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1344302647.18.0.307450045197.issue15569@psf.upfronthosting.co.za>
In-reply-to
Content
After the section describing roles that create cross-references to C-language constructs, the Dev Guide says this, "The following roles don’t do anything special except formatting the text in a different style."

http://hg.python.org/devguide/file/f518f23d06d5/documenting.rst#l984

However, some of the roles following in that section do do special things other than formatting.  For example--

envvar
    An environment variable. Index entries are generated.

keyword
    The name of a Python keyword. Using this role will generate a link to the documentation of the keyword....
    
The description should be changed, or better yet, the roles that do something special should be moved to a different section.
History
Date User Action Args
2012-08-07 01:24:07chris.jerdoneksetrecipients: + chris.jerdonek, ezio.melotti
2012-08-07 01:24:07chris.jerdoneksetmessageid: <1344302647.18.0.307450045197.issue15569@psf.upfronthosting.co.za>
2012-08-07 01:24:06chris.jerdoneklinkissue15569 messages
2012-08-07 01:24:05chris.jerdonekcreate