Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Make the word "Module" in the section header start with an upper-case "M". 

Include "()" when naming functions in the text.

Fixed reference to the built-in str() function.

Format constant names using \code{}.
This commit is contained in:
Fred Drake 1997-12-17 15:30:07 +00:00
parent 20417b7afb
commit 304474f315
2 changed files with 58 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
Doc/lib/liblocale.tex
View File

@ -1,4 +1,4 @@
\section{Standard module \sectcode{locale}} \section{Standard Module \sectcode{locale}}
\stmodindex{locale} \stmodindex{locale}
\label{module-locale} \label{module-locale}
@ -10,8 +10,9 @@ requiring the programmer to know all the specifics of each country
where the software is executed. where the software is executed.
The \code{locale} module is implemented on top of the \code{_locale} The \code{locale} module is implemented on top of the \code{_locale}
module, which in turn uses an ANSI C locale implementation if module, which in turn uses an ANSI \C{} locale implementation if
available. available.
\refbimodindex{_locale}
The \code{locale} module defines the following functions: The \code{locale} module defines the following functions:
@ -28,7 +29,7 @@ raised. If successful, the new locale setting is returned.
If no \var{value} is specified, the current setting for the If no \var{value} is specified, the current setting for the
\var{category} is returned. \var{category} is returned.
\code{setlocale} is not thread safe on most systems. Applications \code{setlocale()} is not thread safe on most systems. Applications
typically start with a call of typically start with a call of
\bcode\begin{verbatim} \bcode\begin{verbatim}
import locale import locale
@ -50,7 +51,7 @@ category.
\item \code{grouping} is a sequence of numbers specifying at which \item \code{grouping} is a sequence of numbers specifying at which
relative positions the \code{thousands_sep} is expected. If the relative positions the \code{thousands_sep} is expected. If the
sequence is terminated with \code{locale.CHAR_MAX}, no further sequence is terminated with \code{locale.CHAR_MAX}, no further
grouping is performed. If the sequence terminates with a 0, the last grouping is performed. If the sequence terminates with a \code{0}, the last
group size is repeatedly used. group size is repeatedly used.
\item \code{thousands_sep} is the character used between groups. \item \code{thousands_sep} is the character used between groups.
\item \code{int_curr_symbol} specifies the international currency \item \code{int_curr_symbol} specifies the international currency
@ -89,74 +90,76 @@ are given below.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strcoll}{string1,string2} \begin{funcdesc}{strcoll}{string1,string2}
Compares two strings according to the current LC_COLLATE setting. As Compares two strings according to the current \code{LC_COLLATE}
any other compare function, returns a negative, or a positive value, setting. As any other compare function, returns a negative, or a
or 0, depending on whether \var{string1} collates before or after positive value, or \code{0}, depending on whether \var{string1}
\var{string2} or is equal to it. collates before or after \var{string2} or is equal to it.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strxfrm}{string} \begin{funcdesc}{strxfrm}{string}
Transforms a string to one that can be used for the builtin function Transforms a string to one that can be used for the builtin function
\code{cmp}, and still returns locale-aware results. This function can be \code{cmp()}, and still returns locale-aware results. This function can be
used when the same string is compared repeatedly, e.g. when collating used when the same string is compared repeatedly, e.g. when collating
a sequence of strings. a sequence of strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{format}{format,val\optional{grouping=0}} \begin{funcdesc}{format}{format,val\optional{grouping=0}}
Formats a number \var{val} according to the current LC_NUMERIC Formats a number \var{val} according to the current \code{LC_NUMERIC}
setting. The format follows the conventions of the \% operator. For setting. The format follows the conventions of the \code{\%} operator. For
floating point values, the decimal point is modified if floating point values, the decimal point is modified if
appropriate. If \var{grouping} is true, also takes the grouping into appropriate. If \var{grouping} is true, also takes the grouping into
account. account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{str}{float} \begin{funcdesc}{str}{float}
Formats a floating point number using the same format as Formats a floating point number using the same format as the built-in
\code{string.str}, but takes the decimal point into account. function \code{str(\var{float})}, but takes the decimal point into
account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atof}{string} \begin{funcdesc}{atof}{string}
Converts a string to a floating point number, following the LC_NUMERIC Converts a string to a floating point number, following the \code{LC_NUMERIC}
settings. settings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{string} \begin{funcdesc}{atoi}{string}
Converts a string to an integer, following the LC_NUMERIC conventions. Converts a string to an integer, following the \code{LC_NUMERIC} conventions.
\end{funcdesc} \end{funcdesc}
\begin{datadesc}{LC_CTYPE} \begin{datadesc}{LC_CTYPE}
\refstmodindex{string}
Locale category for the character type functions. Depending on the Locale category for the character type functions. Depending on the
settings of this category, the functions of module \code{string} settings of this category, the functions of module \code{string}
dealing with case change their behaviour. dealing with case change their behaviour.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_COLLATE} \begin{datadesc}{LC_COLLATE}
Locale category for sorting strings. The functions \code{strcoll} and Locale category for sorting strings. The functions \code{strcoll()} and
\code{strxfrm} of the locale module are affected. \code{strxfrm()} of the \code{locale} module are affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_TIME} \begin{datadesc}{LC_TIME}
Locale category for the formatting of time. The function Locale category for the formatting of time. The function
\code{time.strftime} follows these conventions. \code{time.strftime()} follows these conventions.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MONETARY} \begin{datadesc}{LC_MONETARY}
Locale category for formatting of monetary values. The available Locale category for formatting of monetary values. The available
options are available from the \code{localeconv} function. options are available from the \code{localeconv()} function.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MESSAGES} \begin{datadesc}{LC_MESSAGES}
Locale category for message display. Python currently does not support Locale category for message display. Python currently does not support
application specific locale-aware messages. Messages displayed by the application specific locale-aware messages. Messages displayed by the
operating system, like those returned by \code{posix.strerror} might operating system, like those returned by \code{posix.strerror()} might
be affected by this category. be affected by this category.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_NUMERIC} \begin{datadesc}{LC_NUMERIC}
Locale category for formatting numbers. The functions Locale category for formatting numbers. The functions
\code{format}, \code{atoi}, \code{atof} and \code{str} of the locale module \code{format()}, \code{atoi()}, \code{atof()} and \code{str()} of the
are affected by that category. All other numeric formatting operations \code{locale} module are affected by that category. All other numeric
are not affected. formatting operations are not affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_ALL} \begin{datadesc}{LC_ALL}
@ -170,11 +173,11 @@ used to restore the settings.
\begin{datadesc}{CHAR_MAX} \begin{datadesc}{CHAR_MAX}
This is a symbolic constant used for different values returned by This is a symbolic constant used for different values returned by
\code{localeconv}. \code{localeconv()}.
\end{datadesc} \end{datadesc}
\begin{excdesc}{Error} \begin{excdesc}{Error}
Exception raised when \code{setlocale} fails. Exception raised when \code{setlocale()} fails.
\end{excdesc} \end{excdesc}
Example: Example:

53
Doc/liblocale.tex
View File

@ -1,4 +1,4 @@
\section{Standard module \sectcode{locale}} \section{Standard Module \sectcode{locale}}
\stmodindex{locale} \stmodindex{locale}
\label{module-locale} \label{module-locale}
@ -10,8 +10,9 @@ requiring the programmer to know all the specifics of each country
where the software is executed. where the software is executed.
The \code{locale} module is implemented on top of the \code{_locale} The \code{locale} module is implemented on top of the \code{_locale}
module, which in turn uses an ANSI C locale implementation if module, which in turn uses an ANSI \C{} locale implementation if
available. available.
\refbimodindex{_locale}
The \code{locale} module defines the following functions: The \code{locale} module defines the following functions:
@ -28,7 +29,7 @@ raised. If successful, the new locale setting is returned.
If no \var{value} is specified, the current setting for the If no \var{value} is specified, the current setting for the
\var{category} is returned. \var{category} is returned.
\code{setlocale} is not thread safe on most systems. Applications \code{setlocale()} is not thread safe on most systems. Applications
typically start with a call of typically start with a call of
\bcode\begin{verbatim} \bcode\begin{verbatim}
import locale import locale
@ -50,7 +51,7 @@ category.
\item \code{grouping} is a sequence of numbers specifying at which \item \code{grouping} is a sequence of numbers specifying at which
relative positions the \code{thousands_sep} is expected. If the relative positions the \code{thousands_sep} is expected. If the
sequence is terminated with \code{locale.CHAR_MAX}, no further sequence is terminated with \code{locale.CHAR_MAX}, no further
grouping is performed. If the sequence terminates with a 0, the last grouping is performed. If the sequence terminates with a \code{0}, the last
group size is repeatedly used. group size is repeatedly used.
\item \code{thousands_sep} is the character used between groups. \item \code{thousands_sep} is the character used between groups.
\item \code{int_curr_symbol} specifies the international currency \item \code{int_curr_symbol} specifies the international currency
@ -89,74 +90,76 @@ are given below.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strcoll}{string1,string2} \begin{funcdesc}{strcoll}{string1,string2}
Compares two strings according to the current LC_COLLATE setting. As Compares two strings according to the current \code{LC_COLLATE}
any other compare function, returns a negative, or a positive value, setting. As any other compare function, returns a negative, or a
or 0, depending on whether \var{string1} collates before or after positive value, or \code{0}, depending on whether \var{string1}
\var{string2} or is equal to it. collates before or after \var{string2} or is equal to it.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strxfrm}{string} \begin{funcdesc}{strxfrm}{string}
Transforms a string to one that can be used for the builtin function Transforms a string to one that can be used for the builtin function
\code{cmp}, and still returns locale-aware results. This function can be \code{cmp()}, and still returns locale-aware results. This function can be
used when the same string is compared repeatedly, e.g. when collating used when the same string is compared repeatedly, e.g. when collating
a sequence of strings. a sequence of strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{format}{format,val\optional{grouping=0}} \begin{funcdesc}{format}{format,val\optional{grouping=0}}
Formats a number \var{val} according to the current LC_NUMERIC Formats a number \var{val} according to the current \code{LC_NUMERIC}
setting. The format follows the conventions of the \% operator. For setting. The format follows the conventions of the \code{\%} operator. For
floating point values, the decimal point is modified if floating point values, the decimal point is modified if
appropriate. If \var{grouping} is true, also takes the grouping into appropriate. If \var{grouping} is true, also takes the grouping into
account. account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{str}{float} \begin{funcdesc}{str}{float}
Formats a floating point number using the same format as Formats a floating point number using the same format as the built-in
\code{string.str}, but takes the decimal point into account. function \code{str(\var{float})}, but takes the decimal point into
account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atof}{string} \begin{funcdesc}{atof}{string}
Converts a string to a floating point number, following the LC_NUMERIC Converts a string to a floating point number, following the \code{LC_NUMERIC}
settings. settings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{string} \begin{funcdesc}{atoi}{string}
Converts a string to an integer, following the LC_NUMERIC conventions. Converts a string to an integer, following the \code{LC_NUMERIC} conventions.
\end{funcdesc} \end{funcdesc}
\begin{datadesc}{LC_CTYPE} \begin{datadesc}{LC_CTYPE}
\refstmodindex{string}
Locale category for the character type functions. Depending on the Locale category for the character type functions. Depending on the
settings of this category, the functions of module \code{string} settings of this category, the functions of module \code{string}
dealing with case change their behaviour. dealing with case change their behaviour.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_COLLATE} \begin{datadesc}{LC_COLLATE}
Locale category for sorting strings. The functions \code{strcoll} and Locale category for sorting strings. The functions \code{strcoll()} and
\code{strxfrm} of the locale module are affected. \code{strxfrm()} of the \code{locale} module are affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_TIME} \begin{datadesc}{LC_TIME}
Locale category for the formatting of time. The function Locale category for the formatting of time. The function
\code{time.strftime} follows these conventions. \code{time.strftime()} follows these conventions.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MONETARY} \begin{datadesc}{LC_MONETARY}
Locale category for formatting of monetary values. The available Locale category for formatting of monetary values. The available
options are available from the \code{localeconv} function. options are available from the \code{localeconv()} function.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MESSAGES} \begin{datadesc}{LC_MESSAGES}
Locale category for message display. Python currently does not support Locale category for message display. Python currently does not support
application specific locale-aware messages. Messages displayed by the application specific locale-aware messages. Messages displayed by the
operating system, like those returned by \code{posix.strerror} might operating system, like those returned by \code{posix.strerror()} might
be affected by this category. be affected by this category.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_NUMERIC} \begin{datadesc}{LC_NUMERIC}
Locale category for formatting numbers. The functions Locale category for formatting numbers. The functions
\code{format}, \code{atoi}, \code{atof} and \code{str} of the locale module \code{format()}, \code{atoi()}, \code{atof()} and \code{str()} of the
are affected by that category. All other numeric formatting operations \code{locale} module are affected by that category. All other numeric
are not affected. formatting operations are not affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_ALL} \begin{datadesc}{LC_ALL}
@ -170,11 +173,11 @@ used to restore the settings.
\begin{datadesc}{CHAR_MAX} \begin{datadesc}{CHAR_MAX}
This is a symbolic constant used for different values returned by This is a symbolic constant used for different values returned by
\code{localeconv}. \code{localeconv()}.
\end{datadesc} \end{datadesc}
\begin{excdesc}{Error} \begin{excdesc}{Error}
Exception raised when \code{setlocale} fails. Exception raised when \code{setlocale()} fails.
\end{excdesc} \end{excdesc}
Example: Example: