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 eric.araujo
Recipients eric.araujo, ezio.melotti, georg.brandl, louiscipher, terry.reedy
Date 2011-08-08.14:31:19
SpamBayes Score 6.5969076e-08
Marked as misclassified No
Message-id <1312813881.33.0.389938190576.issue12301@psf.upfronthosting.co.za>
In-reply-to
Content
> I would like to help out with this, as there seems to be a lot of
> work that needs to be done.

Thanks!  In my initial report, I was talking only about module-level names that are documented as code (``sys.path``) instead of module-level data (:data:`sys.path`); the point is that the latter form creates a link to the doc of the module-level name.

I wasn’t aware that some functions and keywords used code markup instead or link-creating markup, like you found out for eval and getattr.  These should be fixed too.

Terry: You’re right, ``x`` is the most generic markup for inline code in reST.  It is used for command lines, program options that are not Python’s options (see #9312), bits of Python code, etc.

Now, about the amount of work needed: Don’t waste hours looking for all of these in the docs!  If you know basic shell commands, it’s easy to have *all* instances of ``sys.path`` changed to :data:`sys.path` in one go.  The thing requiring human attention is first listing all of the misuses of ````, second reviewing the changes.
History
Date User Action Args
2011-08-08 14:31:21eric.araujosetrecipients: + eric.araujo, georg.brandl, terry.reedy, ezio.melotti, louiscipher
2011-08-08 14:31:21eric.araujosetmessageid: <1312813881.33.0.389938190576.issue12301@psf.upfronthosting.co.za>
2011-08-08 14:31:20eric.araujolinkissue12301 messages
2011-08-08 14:31:19eric.araujocreate