From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sun, 7 Jul 2013 16:02:15 +0000 (-0400)
Subject: remove undoc-members from query docstring [ticket:2774]
X-Git-Tag: rel_0_8_3~102
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=124db0eb91ec792df7a9c8b86d300caf453424e8;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

remove undoc-members from query docstring [ticket:2774]
---

diff --git a/doc/build/orm/query.rst b/doc/build/orm/query.rst
index e5358792ca..73aa5c5551 100644
--- a/doc/build/orm/query.rst
+++ b/doc/build/orm/query.rst
@@ -21,7 +21,6 @@ Following is the full interface for the :class:`.Query` object.
 
 .. autoclass:: sqlalchemy.orm.query.Query
    :members:
-   :undoc-members:
 
 ORM-Specific Query Constructs
 -----------------------------
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index 13699316fb..9a85374b44 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -575,6 +575,13 @@ class Query(object):
 
     @property
     def selectable(self):
+        """Return the :class:`.Select` object emitted by this :class:`.Query`.
+
+        Used for :func:`.inspect` compatibility, this is equivalent to::
+
+            query.enable_eagerloads(False).with_labels().statement
+
+        """
         return self.__clause_element__()
 
     def __clause_element__(self):