diff Doc/lib/libstdtypes.tex @ 23147:dbf013cc3dee 2.2

backport fdrake's patch: Document the optional argument to the .strip(), .rstrip(), .strip() string methods. Part of SF feature #444708. Original patches were: python/dist/src/Doc/lib/libstdtypes.tex:1.87
author Anthony Baxter <anthonybaxter@gmail.com>
date Thu, 18 Apr 2002 05:22:33 +0000
parents 7ecc49117d7e
children b08b51dce264
line wrap: on
line diff
--- a/Doc/lib/libstdtypes.tex	Thu Apr 18 05:21:16 2002 +0000
+++ b/Doc/lib/libstdtypes.tex	Thu Apr 18 05:22:33 2002 +0000
@@ -598,8 +598,12 @@
 Return a copy of the string converted to lowercase.
 \end{methoddesc}
 
-\begin{methoddesc}[string]{lstrip}{}
-Return a copy of the string with leading whitespace removed.
+\begin{methoddesc}[string]{lstrip}{\optional{chars}}
+Return a copy of the string with leading characters removed.  If
+\var{chars} is omitted or \code{None}, whitespace characters are
+removed.  If given and not \code{None}, \var{chars} must be a string;
+the characters in the string will be stripped from the beginning of
+the string this method is called on.
 \end{methoddesc}
 
 \begin{methoddesc}[string]{replace}{old, new\optional{, maxsplit}}
@@ -627,8 +631,12 @@
 \var{width} is less than \code{len(\var{s})}.
 \end{methoddesc}
 
-\begin{methoddesc}[string]{rstrip}{}
-Return a copy of the string with trailing whitespace removed.
+\begin{methoddesc}[string]{rstrip}{\optional{chars}}
+Return a copy of the string with trailing characters removed.  If
+\var{chars} is omitted or \code{None}, whitespace characters are
+removed.  If given and not \code{None}, \var{chars} must be a string;
+the characters in the string will be stripped from the end of the
+string this method is called on.
 \end{methoddesc}
 
 \begin{methoddesc}[string]{split}{\optional{sep \optional{,maxsplit}}}
@@ -644,16 +652,20 @@
 \var{keepends} is given and true.
 \end{methoddesc}
 
-\begin{methoddesc}[string]{startswith}{prefix\optional{, start\optional{, end}}}
+\begin{methoddesc}[string]{startswith}{prefix\optional{,
+                                       start\optional{, end}}}
 Return true if string starts with the \var{prefix}, otherwise
 return false.  With optional \var{start}, test string beginning at
 that position.  With optional \var{end}, stop comparing string at that
 position.
 \end{methoddesc}
 
-\begin{methoddesc}[string]{strip}{}
-Return a copy of the string with leading and trailing whitespace
-removed.
+\begin{methoddesc}[string]{strip}{\optional{chars}}
+Return a copy of the string with leading and trailing characters
+removed.  If \var{chars} is omitted or \code{None}, whitespace
+characters are removed.  If given and not \code{None}, \var{chars}
+must be a string; the characters in the string will be stripped from
+the both ends of the string this method is called on.
 \end{methoddesc}
 
 \begin{methoddesc}[string]{swapcase}{}