➜

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.

classification
Title: optparse docs double-dash confusion
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: gward Nosy List: georg.brandl, georg.brandl, gward, pelago, splitscreen
Priority: normal Keywords:

Created on 2006-02-16 12:28 by pelago, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (5)
msg27541 - (view) Author: John Veness (pelago) Date: 2006-02-16 12:28 
Page
http://docs.python.org/lib/optparse-terminology.html says:

The GNU project introduced "-" followed by a series of
hyphen-separated words, e.g. "-file" or "-dry-run".

but should say:

The GNU project introduced "--" followed by a series of
hyphen-separated words, e.g. "--file" or "--dry-run".

Also at the bottom of that page:

"-v" and "-report" are both options.

should be:

"-v" and "--report" are both options.

It looks in general that there is a documentation
rendering problem when double-dash appears in quotes.
Other double-dash items on that page are ok, when not
in quotes.
msg27542 - (view) Author: Matt Fleming (splitscreen) Date: 2006-02-16 20:59 
Logged In: YES 
user_id=1126061

Patch provided: #1433148
msg27543 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-02-17 09:05 
Logged In: YES 
user_id=1188172

A suggested fix is to replace "-{}-" by "{--}" for long
options. Greg?
msg27544 - (view) Author: Matt Fleming (splitscreen) Date: 2006-02-18 11:24 
Logged In: YES 
user_id=1126061

Yeah, that's all that the patch that I provided does.
msg27545 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-03-18 08:26 
Logged In: YES 
user_id=849994

Now fixed in SVN.
History
Date User Action Args
2022-04-11 14:56:15adminsetgithub: 42910
2006-02-16 12:28:52pelagocreate