diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-02-12 18:30:42 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2012-02-12 18:30:42 -0500 |
| commit | d3ff10e035890c5a7ac86d57d85fd322113fb39a (patch) | |
| tree | 0928ab4e0b176fdafd36ec9ff8fc17ebff3df77f /lib/sqlalchemy/ext/orderinglist.py | |
| parent | 38b7cef9828acc360c6a356a8a6bbf4f85a04348 (diff) | |
| download | sqlalchemy-d3ff10e035890c5a7ac86d57d85fd322113fb39a.tar.gz | |
- add OrderingList class and other functions to sphinx documentation
[ticket:2391]
Diffstat (limited to 'lib/sqlalchemy/ext/orderinglist.py')
| -rw-r--r-- | lib/sqlalchemy/ext/orderinglist.py | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/lib/sqlalchemy/ext/orderinglist.py b/lib/sqlalchemy/ext/orderinglist.py index 9847861b0..38957250b 100644 --- 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 |
