- add OrderingList class and other functions to sphinx documentation

[ticket:2391]

diff --git a/doc/build/orm/extensions/orderinglist.rst b/doc/build/orm/extensions/orderinglist.rst
index 940989ea109147af1d15b17a77cb9d2989beb7d9..19599a57828286e2a2877e7ba8e40a98ebc6597a 100644 (file)
--- a/doc/build/orm/extensions/orderinglist.rst
+++ b/doc/build/orm/extensions/orderinglist.rst
@@ -7,3 +7,12 @@ API Reference
 -------------
 
 .. autofunction:: ordering_list
+
+.. autofunction:: count_from_0
+
+.. autofunction:: count_from_1
+
+.. autofunction:: count_from_n_factory
+
+.. autoclass:: OrderingList
+    :members:

diff --git a/lib/sqlalchemy/ext/orderinglist.py b/lib/sqlalchemy/ext/orderinglist.py
index 9847861b0d1026f35fabe95d801b95b434b42cdc..38957250b83521512b67e5dcb4160b0f4f97f8e1 100644 (file)
--- a/lib/sqlalchemy/ext/orderinglist.py
+++ b/lib/sqlalchemy/ext/orderinglist.py
@@ -184,12 +184,11 @@ class OrderingList(list):
         This implementation relies on the list starting in the proper order,
         so be **sure** to put an ``order_by`` on your relationship.
 
-        ordering_attr
+        :param ordering_attr: 
           Name of the attribute that stores the object's order in the
           relationship.
 
-        ordering_func
-          Optional.  A function that maps the position in the Python list to a
+        :param ordering_func: Optional.  A function that maps the position in the Python list to a
           value to store in the ``ordering_attr``.  Values returned are
           usually (but need not be!) integers.
 
@@ -202,7 +201,7 @@ class OrderingList(list):
           like stepped numbering, alphabetical and Fibonacci numbering, see
           the unit tests.
 
-        reorder_on_append
+        :param reorder_on_append: 
           Default False.  When appending an object with an existing (non-None)
           ordering value, that value will be left untouched unless
           ``reorder_on_append`` is true.  This is an optimization to avoid a