Incorrect docs for optparse OptionParser add_help_option

[forest]

BPO	1742164
Nosy	@birkenfeld

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2007-08-23.21:48:17.098>
created_at = <Date 2007-06-23.18:16:54.000>
labels = ['docs']
title = 'Incorrect docs for optparse OptionParser add_help_option'
updated_at = <Date 2007-08-23.21:48:17.096>
user = 'https://bugs.python.org/forest'

bugs.python.org fields:

activity = <Date 2007-08-23.21:48:17.096>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = <Date 2007-08-23.21:48:17.098>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2007-06-23.18:16:54.000>
creator = 'forest'
dependencies = []
files = []
hgrepos = []
issue_num = 1742164
keywords = []
message_count = 2.0
messages = ['32384', '55226']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'forest']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1742164'
versions = []

[forest]

http://www.python.org/doc/2.5/lib/optparse-creating-parser.html

The docs say:

"add_help_option (default: True) If true, optparse will add a help option (with option strings "-h" and "-help") to the parser."

In fact, it adds option strings "-h" and "--help". Note the additional '-' character as compared to the documentation.

[birkenfeld]

This is finally fixed with the new sources and toolset.