summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2004-06-03 09:47:01 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2004-06-03 09:47:01 (GMT)
commit4a9b8069e0e63bd010e58b118fe7d58e8256a11b (patch)
treee9ff29c695e53f50b5731e06d406e1d9c131811d
parent558d9bf5286b5c4f14c92e2e81532dd7fdd3a332 (diff)
downloadcpython-4a9b8069e0e63bd010e58b118fe7d58e8256a11b.zip
cpython-4a9b8069e0e63bd010e58b118fe7d58e8256a11b.tar.gz
cpython-4a9b8069e0e63bd010e58b118fe7d58e8256a11b.tar.bz2
Document string methods that are locale-dependent. Fixes #935749.
Will backport to 2.3.
-rw-r--r--Doc/lib/libstdtypes.tex24
1 files changed, 24 insertions, 0 deletions
diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
index 3526f95..1ffea08 100644
--- a/Doc/lib/libstdtypes.tex
+++ b/Doc/lib/libstdtypes.tex
@@ -546,6 +546,8 @@ objects support:
\begin{methoddesc}[string]{capitalize}{}
Return a copy of the string with only its first character capitalized.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{center}{width\optional{, fillchar}}
@@ -608,26 +610,36 @@ substring is not found.
\begin{methoddesc}[string]{isalnum}{}
Return true if all characters in the string are alphanumeric and there
is at least one character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{isalpha}{}
Return true if all characters in the string are alphabetic and there
is at least one character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{isdigit}{}
Return true if all characters in the string are digits and there
is at least one character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{islower}{}
Return true if all cased characters in the string are lowercase and
there is at least one cased character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{isspace}{}
Return true if there are only whitespace characters in the string and
there is at least one character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\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
characters and lowercase characters only cased ones. Return false
otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{isupper}{}
Return true if all cased characters in the string are uppercase and
there is at least one cased character, false otherwise.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{iswide}{}
@@ -664,6 +680,8 @@ space). The original string is returned if
\begin{methoddesc}[string]{lower}{}
Return a copy of the string converted to lowercase.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\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}{}
Return a copy of the string with uppercase characters converted to
lowercase and vice versa.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{title}{}
Return a titlecased version of the string: words start with uppercase
characters, all remaining cased characters are lowercase.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{translate}{table\optional{, deletechars}}
@@ -778,6 +800,8 @@ character mapping codec using the \refmodule{codecs} module (see
\begin{methoddesc}[string]{upper}{}
Return a copy of the string converted to uppercase.
+
+For 8-bit strings, this method is locale-dependent.
\end{methoddesc}
\begin{methoddesc}[string]{width}{}