From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Mon, 9 Jun 2008 01:49:59 +0000 (+0000)
Subject: docstrings for instances()/iterate_instances()
X-Git-Tag: rel_0_5beta1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e83459d37d6ce687fbfd0fc5162707243d04611a;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

docstrings for instances()/iterate_instances()
---

diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index df775a1772..43a7c41a3a 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -1042,9 +1042,26 @@ class Query(object):
         return self.iterate_instances(result, querycontext)
 
     def instances(self, cursor, __context=None):
+        """Given a ResultProxy cursor as returned by connection.execute(), return an ORM result as a list.
+
+        e.g.::
+        
+            result = engine.execute("select * from users")
+            users = session.query(User).instances(result)
+
+        """
         return list(self.iterate_instances(cursor, __context))
 
     def iterate_instances(self, cursor, __context=None):
+        """Given a ResultProxy cursor as returned by connection.execute(), return an ORM result as an iterator.
+        
+        e.g.::
+        
+            result = engine.execute("select * from users")
+            for u in session.query(User).iterate_instances(result):
+                print u
+
+        """
         session = self.session
 
         context = __context