From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Mon, 1 Dec 2008 05:04:55 +0000 (+0000)
Subject: propagate docstrings for column/fk collections
X-Git-Tag: rel_0_5_0~152
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8617b3fe344f6613472f00cc318edc3d709e35cf;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

propagate docstrings for column/fk collections
---

diff --git a/lib/sqlalchemy/sql/expression.py b/lib/sqlalchemy/sql/expression.py
index 4b47a119f0..3d66ff21be 100644
--- a/lib/sqlalchemy/sql/expression.py
+++ b/lib/sqlalchemy/sql/expression.py
@@ -1851,25 +1851,31 @@ class FromClause(Selectable):
 
     @util.memoized_property
     def _columns(self):
+        """Return the collection of Column objects contained by this FromClause."""
+
         self._export_columns()
         return self._columns
-    
+
     @util.memoized_property
     def _primary_key(self):
+        """Return the collection of Column objects which comprise the primary key of this FromClause."""
+
         self._export_columns()
         return self._primary_key
-    
+
     @util.memoized_property
     def _foreign_keys(self):
+        """Return the collection of ForeignKey objects which this FromClause references."""
+
         self._export_columns()
         return self._foreign_keys
-        
-    columns = property(attrgetter('_columns'))
-    primary_key = property(attrgetter('_primary_key'))
-    foreign_keys = property(attrgetter('_foreign_keys'))
+
+    columns = property(attrgetter('_columns'), doc=_columns.__doc__)
+    primary_key = property(attrgetter('_primary_key'), doc=_primary_key.__doc__)
+    foreign_keys = property(attrgetter('_foreign_keys'), doc=_foreign_keys.__doc__)
 
     # synonyms for 'columns'
-    c = _select_iterable = property(attrgetter('columns'))
+    c = _select_iterable = property(attrgetter('columns'), doc=_columns.__doc__)
     
     def _export_columns(self):
         """Initialize column collections."""