misc TYPO in argparse.Action docstring

[shimashima]

BPO	14391
Nosy	@terryjreedy, @bitdancer
Files	argparse.py.patch

^{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 2012-07-21.21:08:41.196>
created_at = <Date 2012-03-23.06:25:32.959>
labels = ['easy', 'type-bug', 'library', 'docs']
title = 'misc TYPO in argparse.Action docstring'
updated_at = <Date 2012-07-21.21:08:41.193>
user = 'https://bugs.python.org/shimashima'

bugs.python.org fields:

activity = <Date 2012-07-21.21:08:41.193>
actor = 'r.david.murray'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-07-21.21:08:41.196>
closer = 'r.david.murray'
components = ['Documentation', 'Library (Lib)']
creation = <Date 2012-03-23.06:25:32.959>
creator = 'shima__shima'
dependencies = []
files = ['25000']
hgrepos = []
issue_num = 14391
keywords = ['patch', 'easy']
message_count = 5.0
messages = ['156635', '156727', '166061', '166069', '166070']
nosy_count = 6.0
nosy_names = ['terry.reedy', 'bethard', 'r.david.murray', 'docs@python', 'python-dev', 'shima__shima']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue14391'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']

[shimashima]

Keywords to specify as string type are incorrect.
'string' should be 'str'

[terryjreedy]

The patch, to an unspecified version of 2.7, changes 'str' to 'string', so I presume that is what you meant. The current repository code already says 'string' for 2.7, 3.2, and 3.3. This is what you should see in the current release candidates, including 2.7.3rc2

[bethard]

The patch supplied was in reverse, but the bug report was correct. You can't pass "type=string" since there's no string callable, only a str callable.

The docstring is confusing because the quotes make it looks like we mean the string 'str', when we actually mean the callable 'str'. Maybe they should be str or str? Not sure what the syntax for code, not string literals, is for docstrings.

Anyway, this should be an easy fix for a doc person.

[python-dev]

New changeset e7f205ce080e by R David Murray in branch '3.2':
bpo-14391: clarify docstring discussion of Action's 'type' argument's value.
http://hg.python.org/cpython/rev/e7f205ce080e

New changeset 3d1ea33611c1 by R David Murray in branch 'default':
Merge bpo-14391: clarify docstring discussion of Action's 'type' argument's value.
http://hg.python.org/cpython/rev/3d1ea33611c1

New changeset 905d9bdae970 by R David Murray in branch '2.7':
bpo-14391: clarify docstring discussion of Action's 'type' argument's value.
http://hg.python.org/cpython/rev/905d9bdae970

[bitdancer]

I reworded it so that it is clear we are talking about types and not strings.