Commit a466092f authored by Fred Drake's avatar Fred Drake

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

methods.
Part of SF feature #444708.
parent 4a6b68ef
...@@ -603,8 +603,12 @@ Padding is done using spaces. The original string is returned if ...@@ -603,8 +603,12 @@ Padding is done using spaces. The original string is returned if
Return a copy of the string converted to lowercase. Return a copy of the string converted to lowercase.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{lstrip}{} \begin{methoddesc}[string]{lstrip}{\optional{chars}}
Return a copy of the string with leading whitespace removed. 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} \end{methoddesc}
\begin{methoddesc}[string]{replace}{old, new\optional{, maxsplit}} \begin{methoddesc}[string]{replace}{old, new\optional{, maxsplit}}
...@@ -632,8 +636,12 @@ Padding is done using spaces. The original string is returned if ...@@ -632,8 +636,12 @@ Padding is done using spaces. The original string is returned if
\var{width} is less than \code{len(\var{s})}. \var{width} is less than \code{len(\var{s})}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{rstrip}{} \begin{methoddesc}[string]{rstrip}{\optional{chars}}
Return a copy of the string with trailing whitespace removed. 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} \end{methoddesc}
\begin{methoddesc}[string]{split}{\optional{sep \optional{,maxsplit}}} \begin{methoddesc}[string]{split}{\optional{sep \optional{,maxsplit}}}
...@@ -649,16 +657,20 @@ boundaries. Line breaks are not included in the resulting list unless ...@@ -649,16 +657,20 @@ boundaries. Line breaks are not included in the resulting list unless
\var{keepends} is given and true. \var{keepends} is given and true.
\end{methoddesc} \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 true if string starts with the \var{prefix}, otherwise
return false. With optional \var{start}, test string beginning at return false. With optional \var{start}, test string beginning at
that position. With optional \var{end}, stop comparing string at that that position. With optional \var{end}, stop comparing string at that
position. position.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{strip}{} \begin{methoddesc}[string]{strip}{\optional{chars}}
Return a copy of the string with leading and trailing whitespace Return a copy of the string with leading and trailing characters
removed. 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} \end{methoddesc}
\begin{methoddesc}[string]{swapcase}{} \begin{methoddesc}[string]{swapcase}{}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment