homepage

> Date: 2012年9月13日 09:42:47 -0400
> To: <docs@python.org>
> Subject: [docs] Problem with the documentation for string.replace
>
> >From http://docs.python.org/library/string.html
>
> string.replace(str, old, new[, maxreplace])?<http://docs.python.org/library/string.html#string.replace>
> Return a copy of string str with all occurrences of substring old replaced by new. If the optional argument maxreplace is given, the first maxreplace occurrences are replaced.
>
> it would appear this needs to be
> string.replace(old, new[, maxreplace])?<http://docs.python.org/library/string.html#string.replace>
(from: http://mail.python.org/pipermail/docs/2012-September/010521.html )

No it shoudn't.
It works exactly as described:
Return a copy of string *str* with all occurrences of substring *old* replaced by *new*. If the optional argument *maxreplace* is given, the first *maxreplace* occurrences are replaced.
*str* is updated string and it is definitelly required.

Thanks, Andrew. I didn't look closely enough when reading the e-mail or I wouldn't have posted. I had assumed from the e-mail that this was in the string *method* section rather than string module.

[Reopening] It looks like at least *some* change is warranted here. Notice that all the functions document "s" for the string argument but string.replace() documents "str". However, we have (in 2.7):
>>> string.replace(str='aab', old='a', new='b')
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
TypeError: replace() got an unexpected keyword argument 'str'
>>> string.replace(s='aab', old='a', new='b')
'bbb'

If you want just to change parameter name in the docs — I'm ok with that.

Fixed in c34a177d1f38