[Sqlalchemy-commits] sqlalchemy: - document query_class on relationship

[<co...@sq...>]

details:   http://hg.sqlalchemy.org/sqlalchemy/sqlalchemy/rev/2e7439cb907f
changeset: 7629:2e7439cb907f
user:      zzzeek
date:      Tue May 24 20:31:44 2011 -0400
description:
- document query_class on relationship
- note public constructors for RelationshipProperty, ColumnProperty

diffstat:

 lib/sqlalchemy/orm/__init__.py   |   7 +++++++
 lib/sqlalchemy/orm/properties.py |  11 ++++++++++-
 2 files changed, 17 insertions(+), 1 deletions(-)

diffs (49 lines):

diff -r 5a3be7842013 -r 2e7439cb907f lib/sqlalchemy/orm/__init__.py
--- a/lib/sqlalchemy/orm/__init__.py	Sun May 22 16:42:20 2011 -0400
+++ b/lib/sqlalchemy/orm/__init__.py	Tue May 24 20:31:44 2011 -0400
@@ -490,6 +490,13 @@
       used for self-referential relationships, indicates the column or
       list of columns that form the "remote side" of the relationship.
 
+    :param query_class:
+      a :class:`.Query` subclass that will be used as the base of the
+      "appender query" returned by a "dynamic" relationship, that
+      is, a relationship that specifies ``lazy="dynamic"`` or was 
+      otherwise constructed using the :func:`.orm.dynamic_loader`
+      function.
+      
     :param secondaryjoin:
       a ColumnElement (i.e. WHERE criterion) that will be used as the join of
       an association table to the child object. By default, this value is
diff -r 5a3be7842013 -r 2e7439cb907f lib/sqlalchemy/orm/properties.py
--- a/lib/sqlalchemy/orm/properties.py	Sun May 22 16:42:20 2011 -0400
+++ b/lib/sqlalchemy/orm/properties.py	Tue May 24 20:31:44 2011 -0400
@@ -31,11 +31,17 @@
             ComparableProperty,ConcreteInheritedProperty
 
 class ColumnProperty(StrategizedProperty):
-    """Describes an object attribute that corresponds to a table column."""
+    """Describes an object attribute that corresponds to a table column.
+    
+    Public constructor is the :func:`.orm.column_property` function.
+    
+    """
 
     def __init__(self, *columns, **kwargs):
         """Construct a ColumnProperty.
 
+        Note the public constructor is the :func:`.orm.column_property` function.
+
         :param \*columns: The list of `columns` describes a single
           object property. If there are multiple tables joined
           together for the mapper, this list represents the equivalent
@@ -168,6 +174,9 @@
 class RelationshipProperty(StrategizedProperty):
     """Describes an object property that holds a single item or list
     of items that correspond to a related database table.
+    
+    Public constructor is the :func:`.orm.relationship` function.
+    
     """
 
     def __init__(self, argument,