Changeset 455 for elixir/trunk

Timestamp:

06/30/09 13:12:36 (3 years ago)

Author:

ged

Message:

document order_by "load-only" behavior

Files:

• elixir/trunk/elixir/relationships.py (modified) (2 diffs)

elixir/trunk/elixir/relationships.py

@@ -174 +174 @@
 +====================+========================================================+
 | ``order_by``       | Specify which field(s) should be used to sort the      |
-|                    | results given by accessing the relation field. You can |
-|                    | either use a string or a list of strings, each         |
-|                    | corresponding to the name of a field in the target     |
-|                    | entity. These field names can optionally be prefixed   |
-|                    | by a minus (for descending order).                     |
+|                    | results given by accessing the relation field.         |
+|                    | Note that this sort order is only applied when loading |
+|                    | objects from the database. Objects appended to the     |
+|                    | collection afterwards are not re-sorted in-memory on   |
+|                    | the fly.                                               |
+|                    | This argument accepts either a string or a list of     |
+|                    | strings, each corresponding to the name of a field in  |
+|                    | the target entity. These field names can optionally be |
+|                    | prefixed by a minus (for descending order).            |
 +--------------------+--------------------------------------------------------+
 | ``filter``         | Specify a filter criterion (as a clause element) for   |
@@ -279 +283 @@
 +--------------------+--------------------------------------------------------+
 | ``order_by``       | Specify which field(s) should be used to sort the      |
-|                    | results given by accessing the relation field. You can |
-|                    | either use a string or a list of strings, each         |
-|                    | corresponding to the name of a field in the target     |
-|                    | entity. These field names can optionally be prefixed   |
-|                    | by a minus (for descending order).                     |
+|                    | results given by accessing the relation field.         |
+|                    | Note that this sort order is only applied when loading |
+|                    | objects from the database. Objects appended to the     |
+|                    | collection afterwards are not re-sorted in-memory on   |
+|                    | the fly.                                               |
+|                    | This argument accepts either a string or a list of     |
+|                    | strings, each corresponding to the name of a field in  |
+|                    | the target entity. These field names can optionally be |
+|                    | prefixed by a minus (for descending order).            |
 +----------------------+------------------------------------------------------+
 | ``ondelete``       | Value for the foreign key constraint ondelete clause.  |