[docs] [issue14763] string.split maxsplit documented incorrectly
report at bugs.python.org
Wed May 9 13:30:37 CEST 2012
New submission from Fj <fj.mail at gmail.com>:
string.split documentation says:
> The optional third argument maxsplit defaults to 0. If it is nonzero, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements).
It lies! If you give it maxsplit=0 it doesn't do any splits at all! It should say:
> The optional third argument maxsplit defaults to **-1**. If it is **nonnegative**, at most maxsplit number of splits occur, ...
Additionally, it could specify default values in the function signature explicitly, like re.split does:
string.split(s, sep=None, maxsplit=-1)
string.split(s, [sep, [maxsplit]])
It seems that the inconsistency stems from the time long forgotten (certainly before 2.5) when string.split used the implementation in stropmodule.c (obsolete), which does indeed uses maxsplit=0 (and on which the re.split convention was based, regrettably).
Currently string.split just calls str.split, and that uses maxsplit=-1 to mean unlimited splits.
>From searching "maxsplit" in the bug tracker I understand that split functions have had a rather difficult history and some quirks preserved for the sake of backward compatibility, and not documented for the sake of brevity. In this case, however, the documentation does try to document the particular behaviour, but is wrong, which is really confusing.
Also, maybe an even better fix would be to change the str.split documentation to use the proper signature (`str.split(sep=None, maxsplit=-1)`), and simply say that string.split(s, sep=None, maxsplit=-1) calls s.split(sep, maxsplit) here? Because that's what it does, while having _two_ different, incomplete, partially wrong explanations of the same thing is confusing!
assignee: docs at python
nosy: Fj, docs at python
title: string.split maxsplit documented incorrectly
versions: Python 2.7
Python tracker <report at bugs.python.org>
More information about the docs