Issue #3067: Enhance the documentation and docstring of locale.setlocale()
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst
index 85dad99..9cc3ab5 100644
--- a/Doc/library/locale.rst
+++ b/Doc/library/locale.rst
@@ -23,19 +23,19 @@
.. exception:: Error
- Exception raised when :func:`setlocale` fails.
+ Exception raised when the locale passed to :func:`setlocale` is not
+ recognized.
.. function:: setlocale(category[, locale])
- 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.
@@ -51,7 +51,7 @@
changed thereafter, using multithreading should not cause problems.
.. versionchanged:: 2.0
- Added support for tuple values of the *locale* parameter.
+ Added support for iterable values of the *locale* parameter.
.. function:: localeconv()