str.translate docstring doesn't mention that 'table' can be None

[mdickinson]

BPO	12164
Nosy	@mdickinson, @akheron
Files	str_translate_docstring.patch: Fix docstring of str.translate str_translate_docstring_2.patch: Different wording

^{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 = 'https://github.com/mdickinson'
closed_at = <Date 2011-06-25.09:01:08.956>
created_at = <Date 2011-05-24.05:14:44.469>
labels = ['docs']
title = "str.translate docstring doesn't mention that 'table' can be None"
updated_at = <Date 2011-06-25.09:01:08.955>
user = 'https://github.com/mdickinson'

bugs.python.org fields:

activity = <Date 2011-06-25.09:01:08.955>
actor = 'mark.dickinson'
assignee = 'mark.dickinson'
closed = True
closed_date = <Date 2011-06-25.09:01:08.956>
closer = 'mark.dickinson'
components = ['Documentation']
creation = <Date 2011-05-24.05:14:44.469>
creator = 'mark.dickinson'
dependencies = []
files = ['22122', '22206']
hgrepos = []
issue_num = 12164
keywords = ['patch']
message_count = 6.0
messages = ['136720', '137353', '137356', '137645', '137657', '139028']
nosy_count = 4.0
nosy_names = ['mark.dickinson', 'docs@python', 'python-dev', 'petri.lehtinen']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue12164'
versions = ['Python 2.7']

[mdickinson]

In Python 2.6 and 2.7, str.translate accepts None as a first argument. That's documented in the docs, but not in the str.translate docstring.

[akheron]

I added a patch a few days ago. How does it look?

[akheron]

After discussing with Ezio Melotti, I attached another patch with a different wording.

Mark: As a native English speaker, which one you prefer?

[mdickinson]

Thanks for the patches! Here's a slight expansion of the wording on your second patch:

Return a copy of the string S, where all characters occurring
in the optional argument deletechars are removed, and the
remaining characters have been mapped through the given
translation table, which must be a string of length 256 or None.
If the table argument is None, no translation is applied and
the translation simply removes the characters in deletechars.

What do you think?

[akheron]

What do you think?

Sounds very good to my native Finnish ears :)

[python-dev]

New changeset 60b3a5615c4e by Mark Dickinson in branch '2.7':
Issue bpo-12164: Document (in docstring) that str.translate accepts None for the first argument.
http://hg.python.org/cpython/rev/60b3a5615c4e