summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIuri Diniz <iuridiniz@gmail.com>2016-07-29 13:16:16 -0300
committerIuri Diniz <iuridiniz@gmail.com>2016-07-29 13:16:16 -0300
commit72ee5326c3afac2d31ad0c4123930df43c86413d (patch)
tree4cf30e223477d1a17f6e4b96fc7d2d566fc24fb5
parent3e0666589e1abcfd626cce72fe5f014e46737e8f (diff)
downloadsqlalchemy-pr/297.tar.gz
new docstring for Query.group_bypr/297
Instructions how to suppress GROUP BY.
-rw-r--r--lib/sqlalchemy/orm/query.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index db320d65c..a6cf9e3b9 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -1549,7 +1549,12 @@ class Query(object):
@_generative(_no_statement_condition, _no_limit_offset)
def group_by(self, *criterion):
"""apply one or more GROUP BY criterion to the query and return
- the newly resulting :class:`.Query`"""
+ the newly resulting :class:`.Query`
+
+ All existing GROUP BY settings can be suppressed by passing
+ ``None``.
+
+ """
if len(criterion) == 1:
if criterion[0] is None: