[ python-Bugs-1432838 ] optparse docs double-dash confusion

[SourceForge.net]

Bugs item #1432838, was opened at 2006-02-16 12:28
Message generated for change (Settings changed) made by gbrandl
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1432838&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: John Veness (pelago)
Assigned to: Greg Ward (gward)
Summary: optparse docs double-dash confusion

Initial Comment:
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.

----------------------------------------------------------------------

>Comment By: Georg Brandl (gbrandl)
Date: 2006-03-18 08:26

Message:
Logged In: YES 
user_id=849994

Now fixed in SVN.

----------------------------------------------------------------------

Comment By: splitscreen (splitscreen)
Date: 2006-02-18 11:24

Message:
Logged In: YES 
user_id=1126061

Yeah, that's all that the patch that I provided does.

----------------------------------------------------------------------

Comment By: Georg Brandl (birkenfeld)
Date: 2006-02-17 09:05

Message:
Logged In: YES 
user_id=1188172

A suggested fix is to replace "-{}-" by "{--}" for long
options. Greg?

----------------------------------------------------------------------

Comment By: splitscreen (splitscreen)
Date: 2006-02-16 20:59

Message:
Logged In: YES 
user_id=1126061

Patch provided: #1433148

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1432838&group_id=5470