Document string methods that are locale-dependent. Fixes #935749.

Will backport to 2.3.
This commit is contained in:
Martin v. Löwis 2004-06-03 09:47:01 +00:00
parent 558d9bf528
commit 4a9b8069e0
1 changed files with 24 additions and 0 deletions

View File

@ -546,6 +546,8 @@ objects support:
\begin{methoddesc}[string]{capitalize}{} \begin{methoddesc}[string]{capitalize}{}
Return a copy of the string with only its first character capitalized. Return a copy of the string with only its first character capitalized.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{center}{width\optional{, fillchar}} \begin{methoddesc}[string]{center}{width\optional{, fillchar}}
@ -608,26 +610,36 @@ substring is not found.
\begin{methoddesc}[string]{isalnum}{} \begin{methoddesc}[string]{isalnum}{}
Return true if all characters in the string are alphanumeric and there Return true if all characters in the string are alphanumeric and there
is at least one character, false otherwise. is at least one character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{isalpha}{} \begin{methoddesc}[string]{isalpha}{}
Return true if all characters in the string are alphabetic and there Return true if all characters in the string are alphabetic and there
is at least one character, false otherwise. is at least one character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{isdigit}{} \begin{methoddesc}[string]{isdigit}{}
Return true if all characters in the string are digits and there Return true if all characters in the string are digits and there
is at least one character, false otherwise. is at least one character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{islower}{} \begin{methoddesc}[string]{islower}{}
Return true if all cased characters in the string are lowercase and Return true if all cased characters in the string are lowercase and
there is at least one cased character, false otherwise. there is at least one cased character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{isspace}{} \begin{methoddesc}[string]{isspace}{}
Return true if there are only whitespace characters in the string and Return true if there are only whitespace characters in the string and
there is at least one character, false otherwise. there is at least one character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{istitle}{} \begin{methoddesc}[string]{istitle}{}
@ -635,11 +647,15 @@ Return true if the string is a titlecased string and there is at least one
character, for example uppercase characters may only follow uncased character, for example uppercase characters may only follow uncased
characters and lowercase characters only cased ones. Return false characters and lowercase characters only cased ones. Return false
otherwise. otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{isupper}{} \begin{methoddesc}[string]{isupper}{}
Return true if all cased characters in the string are uppercase and Return true if all cased characters in the string are uppercase and
there is at least one cased character, false otherwise. there is at least one cased character, false otherwise.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{iswide}{} \begin{methoddesc}[string]{iswide}{}
@ -664,6 +680,8 @@ space). The original string is returned if
\begin{methoddesc}[string]{lower}{} \begin{methoddesc}[string]{lower}{}
Return a copy of the string converted to lowercase. Return a copy of the string converted to lowercase.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{lstrip}{\optional{chars}} \begin{methoddesc}[string]{lstrip}{\optional{chars}}
@ -752,11 +770,15 @@ the both ends of the string this method is called on.
\begin{methoddesc}[string]{swapcase}{} \begin{methoddesc}[string]{swapcase}{}
Return a copy of the string with uppercase characters converted to Return a copy of the string with uppercase characters converted to
lowercase and vice versa. lowercase and vice versa.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{title}{} \begin{methoddesc}[string]{title}{}
Return a titlecased version of the string: words start with uppercase Return a titlecased version of the string: words start with uppercase
characters, all remaining cased characters are lowercase. characters, all remaining cased characters are lowercase.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{translate}{table\optional{, deletechars}} \begin{methoddesc}[string]{translate}{table\optional{, deletechars}}
@ -778,6 +800,8 @@ character mapping codec using the \refmodule{codecs} module (see
\begin{methoddesc}[string]{upper}{} \begin{methoddesc}[string]{upper}{}
Return a copy of the string converted to uppercase. Return a copy of the string converted to uppercase.
For 8-bit strings, this method is locale-dependent.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[string]{width}{} \begin{methoddesc}[string]{width}{}