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 Kyle.Simpson, docs@python, eric.araujo, ezio.melotti, ncoghlan, terry.reedy
Date 2011-10-14.14:30:07
SpamBayes Score 7.564606e-10
Marked as misclassified No
Message-id <1318602608.07.0.262513463295.issue12602@psf.upfronthosting.co.za>
In-reply-to
Content
[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.
History
Date User Action Args
2011-10-14 14:30:08eric.araujosetrecipients: + eric.araujo, terry.reedy, ncoghlan, ezio.melotti, docs@python, Kyle.Simpson
2011-10-14 14:30:08eric.araujosetmessageid: <1318602608.07.0.262513463295.issue12602@psf.upfronthosting.co.za>
2011-10-14 14:30:07eric.araujolinkissue12602 messages
2011-10-14 14:30:07eric.araujocreate