Message141779
> 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. |
|
Date |
User |
Action |
Args |
2011-08-08 14:31:21 | eric.araujo | set | recipients:
+ eric.araujo, georg.brandl, terry.reedy, ezio.melotti, louiscipher |
2011-08-08 14:31:21 | eric.araujo | set | messageid: <1312813881.33.0.389938190576.issue12301@psf.upfronthosting.co.za> |
2011-08-08 14:31:20 | eric.araujo | link | issue12301 messages |
2011-08-08 14:31:19 | eric.araujo | create | |
|