[issue12301] Use :data:`sys.thing` instead of ``sys.thing`` throughout

[Éric Araujo]

Éric Araujo <merwok at netwok.org> added the comment:

> 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.

----------

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