Document the optional argument to the .strip(), .rstrip(), .strip() string

freddrake · freddrake · commit 8b1c47bb8bf0 · 2002-04-13T02:43:39.000Z
methods.
Part of SF feature #444708.
diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
@@ -603,8 +603,12 @@ \subsubsection{String Methods \label{string-methods}}
 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}}
@@ -632,8 +636,12 @@ \subsubsection{String Methods \label{string-methods}}
 \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}}}
@@ -649,16 +657,20 @@ \subsubsection{String Methods \label{string-methods}}
 \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}{}
