[docs] [issue12602] Missing cross-references in Doc/using

[Éric Araujo]

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

[Terry]
> It may suggest a meta-issue though - perhaps 'Documenting Python'
> should grow a devguide-style description of the Docs layout in source
> control

I would just describe the layout of the Doc subtree in the same devguide page.  Care to open another bug for that?

> If we consistently applied the "italicize non-literal symbolic parameter names"
> rule to command line examples, we would italicize 'command', 'module-name',
> 'script', and 'args' in
> 
> python [-BdEiOQsStuUvVWxX3?] [-c command | -m module-name | script | - ] [args]
> 
> just like in function signatures. I actually would like that as it would
> similarly diffentiate them from the literal constants meant to be entered as
> written. Has that ever been discussed by the doc group?

Not that I recall.  Currently the “python [-Bd etc.]” line is currently a code block, and as such cannot gain inline markup (:file:), but this is not insurmountable.

----------

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