Issue #3067: Enhance the documentation and docstring of locale.setlocale()

This commit is contained in:
Petri Lehtinen 2011-11-05 10:21:49 +02:00
commit 064e39330d
3 changed files with 14 additions and 12 deletions

View File

@ -22,19 +22,19 @@ The :mod:`locale` module defines the following exception and functions:
.. exception:: Error
Exception raised when :func:`setlocale` fails.
Exception raised when the locale passed to :func:`setlocale` is not
recognized.
.. function:: setlocale(category, locale=None)
If *locale* is specified, it may be a string, a tuple of the form ``(language
code, encoding)``, or ``None``. If it is a tuple, it is converted to a string
using the locale aliasing engine. If *locale* is given and not ``None``,
:func:`setlocale` modifies the locale setting for the *category*. The available
categories are listed in the data description below. The value is the name of a
locale. An empty string specifies the user's default settings. If the
modification of the locale fails, the exception :exc:`Error` is raised. If
successful, the new locale setting is returned.
If *locale* is given and not ``None``, :func:`setlocale` modifies the locale
setting for the *category*. The available categories are listed in the data
description below. *locale* may be a string, or an iterable of two strings
(language code and encoding). If it's an iterable, it's converted to a locale
name using the locale aliasing engine. An empty string specifies the user's
default settings. If the modification of the locale fails, the exception
:exc:`Error` is raised. If successful, the new locale setting is returned.
If *locale* is omitted or ``None``, the current setting for *category* is
returned.

View File

@ -526,9 +526,10 @@ def getlocale(category=LC_CTYPE):
def setlocale(category, locale=None):
""" Set the locale for the given category. The locale can be
a string, a locale tuple (language code, encoding), or None.
a string, an iterable of two strings (language code and encoding),
or None.
Locale tuples are converted to strings the locale aliasing
Iterables are converted to strings using the locale aliasing
engine. Locale strings are passed directly to the C lib.
category may be given as one of the LC_* values.

View File

@ -358,7 +358,8 @@ Library
are read correctly.
- Issue #3067: locale.setlocale() now raises TypeError if the second
argument is an invalid iterable. Initial patch by Jyrki Pulliainen.
argument is an invalid iterable. Its documentation and docstring
were also updated. Initial patch by Jyrki Pulliainen.
- Issue #13140: Fix the daemon_threads attribute of ThreadingMixIn.