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 terry.reedy
Recipients Kyle.Simpson, docs@python, eric.araujo, ezio.melotti, ncoghlan, terry.reedy
Date 2011-10-12.20:18:20
SpamBayes Score 1.1709101e-07
Marked as misclassified No
Message-id <1318450701.28.0.294207113227.issue12602@psf.upfronthosting.co.za>
In-reply-to
Content
Since *script* is a file -- that is all variable -- that seems appropriate. 

Bold italic tends to be more notably different from bold italic than the normal pair. In any case, italic is the doc standard for function parameter names. It seems more sensible than introducing a unique occurrence of angle brackets. An alternative is to simply delete the angle brackets. 

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?
History
Date User Action Args
2011-10-12 20:18:21terry.reedysetrecipients: + terry.reedy, ncoghlan, ezio.melotti, eric.araujo, docs@python, Kyle.Simpson
2011-10-12 20:18:21terry.reedysetmessageid: <1318450701.28.0.294207113227.issue12602@psf.upfronthosting.co.za>
2011-10-12 20:18:20terry.reedylinkissue12602 messages
2011-10-12 20:18:20terry.reedycreate