traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

SF bug #901654: split method documentation can be improved 

* Discuss the algorithmic distinctions between s.split() and s.split(sep).
* Document the split behavior for empty strings.
* Note the behavior when maxsplit is zero.
* Include short examples.
This commit is contained in:
Raymond Hettinger 2004-09-06 00:12:04 +00:00
parent 1b262977a0
commit 18c6960964
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/lib/libstdtypes.tex
View File

@ -750,8 +750,22 @@ string this method is called on.
\begin{methoddesc}[string]{split}{\optional{sep \optional{,maxsplit}}}
Return a list of the words in the string, using \var{sep} as the
delimiter string. If \var{maxsplit} is given, at most \var{maxsplit}
splits are done. If \var{sep} is not specified or \code{None}, any
whitespace string is a separator.
splits are done. (thus, the list will have at most \code{\var{maxsplit}+1}
elements). If \var{maxsplit} is not specified or is zero, then there
is no limit on the number of splits (all possible splits are made).
Consecutive delimiters are not grouped together and are
deemed to delimit empty strings (for example, \samp{'1,,2'.split(',')}
returns \samp{['1', '', '2']}. The \var{sep} argument may consist of
multiple characters (for example, \samp{'1, 2, 3'.split(', ')} returns
\samp{['1', '2', '3']}. Splitting an empty string with a specified
separator returns an empty list.
If \var{sep} is not specified or is \code{None}, a different splitting
algorithm is applied. Words are separated by arbitrary length strings of
whitespace characters (spaces, tabs, newlines, returns, and formfeeds).
Consecutive whitespace delimiters are treated as a single delimiter
(\samp{'1 2 3'.split()} returns \samp{['1', '2', '3']}. Splitting an
empty string returns \samp{['']}.
\end{methoddesc}
\begin{methoddesc}[string]{splitlines}{\optional{keepends}}