summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libshlex.tex
diff options
context:
space:
mode:
authorGustavo Niemeyer <gustavo@niemeyer.net>2003-04-20 01:57:03 (GMT)
committerGustavo Niemeyer <gustavo@niemeyer.net>2003-04-20 01:57:03 (GMT)
commit48f3dcc93e57e75e43f9e1a82daa02d2c2f29ec8 (patch)
tree565d184f58251dabce4907b80cf999593d888c17 /Doc/lib/libshlex.tex
parentcf146d31e72467db55a97169563c813706cef681 (diff)
downloadcpython-48f3dcc93e57e75e43f9e1a82daa02d2c2f29ec8.zip
cpython-48f3dcc93e57e75e43f9e1a82daa02d2c2f29ec8.tar.gz
cpython-48f3dcc93e57e75e43f9e1a82daa02d2c2f29ec8.tar.bz2
- Changed shlex.split() method to have more useful and
meaningful parameters.
Diffstat (limited to 'Doc/lib/libshlex.tex')
-rw-r--r--Doc/lib/libshlex.tex11
1 files changed, 5 insertions, 6 deletions
diff --git a/Doc/lib/libshlex.tex b/Doc/lib/libshlex.tex
index 9ebe16b..56125d3 100644
--- a/Doc/lib/libshlex.tex
+++ b/Doc/lib/libshlex.tex
@@ -25,12 +25,11 @@ Python applications) or for parsing quoted strings.
The \module{shlex} module defines the following functions:
-\begin{funcdesc}{split}{s\optional{, posix=\code{True}\optional{,
- spaces=\code{True}}}}
-Split the string \var{s} using shell-like syntax. If \var{posix} is
-\code{True}, operate in \POSIX{} mode. If \var{spaces} is \code{True}, it
-will only split words in whitespaces (setting the
-\member{whitespace_split} member of the \class{shlex} instance).
+\begin{funcdesc}{split}{s\optional{, comments=\code{False}}}
+Split the string \var{s} using shell-like syntax. If \var{comments} is
+\code{False}, the parsing of comments in the given string will be
+disabled (setting the \member{commenters} member of the \class{shlex}
+instance to the empty string). This function operates in \POSIX{} mode.
\versionadded{2.3}
\end{funcdesc}