From: Aarni Koskela <akx@iki.fi>
Date: Fri, 8 Jan 2016 08:39:08 +0000 (+0200)
Subject: Add docs for `babel.lists`
X-Git-Tag: 2.3.1~30^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e1e9913d35d1bf0e10f9471479d7618d9ff4df4;p=thirdparty%2Fbabel.git

Add docs for `babel.lists`
---

diff --git a/babel/lists.py b/babel/lists.py
index 6e6fbd19..82e5590c 100644
--- a/babel/lists.py
+++ b/babel/lists.py
@@ -21,9 +21,9 @@ DEFAULT_LOCALE = default_locale()
 
 
 def format_list(lst, locale=DEFAULT_LOCALE):
-    """ Formats `lst` as a list
+    """
+    Format the items in `lst` as a list.
 
-    e.g.
     >>> format_list(['apples', 'oranges', 'pears'], 'en')
     u'apples, oranges, and pears'
     >>> format_list(['apples', 'oranges', 'pears'], 'zh')
diff --git a/docs/api/index.rst b/docs/api/index.rst
index e21fa74e..b882d300 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -9,6 +9,7 @@ public API of Babel.
 
    core
    dates
+   lists
    messages/index
    numbers
    plural
diff --git a/docs/api/lists.rst b/docs/api/lists.rst
new file mode 100644
index 00000000..d526b6a7
--- /dev/null
+++ b/docs/api/lists.rst
@@ -0,0 +1,8 @@
+List Formatting
+===============
+
+.. module:: babel.lists
+
+This module lets you format lists of items in a locale-dependent manner.
+
+.. autofunction:: format_list