From 6b418348558e7efc5bac459989887138a3045886 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 5 Jun 2015 11:40:10 -0400 Subject: [PATCH] Minor edits to Greatest/Least docs; refs #24767. --- django/db/models/functions.py | 6 ++---- docs/ref/models/database-functions.txt | 22 +++++++++++----------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/django/db/models/functions.py b/django/db/models/functions.py index 978d2c16bf..dcc54e6fa5 100644 --- a/django/db/models/functions.py +++ b/django/db/models/functions.py @@ -89,8 +89,7 @@ class Greatest(Func): If any expression is null the return value is database-specific: On Postgres, the maximum not-null expression is returned. - On MySQL, Oracle and SQLite, if any expression is null, null is - returned. + On MySQL, Oracle, and SQLite, if any expression is null, null is returned. """ function = 'GREATEST' @@ -110,8 +109,7 @@ class Least(Func): If any expression is null the return value is database-specific: On Postgres, the minimum not-null expression is returned. - On MySQL, Oracle and SQLite, if any expression is null, null is - returned. + On MySQL, Oracle, and SQLite, if any expression is null, null is returned. """ function = 'LEAST' diff --git a/docs/ref/models/database-functions.txt b/docs/ref/models/database-functions.txt index 3477bd3263..f1293ba741 100644 --- a/docs/ref/models/database-functions.txt +++ b/docs/ref/models/database-functions.txt @@ -96,13 +96,13 @@ Usage example:: Greatest -------- -.. versionadded:: 1.9 - .. class:: Greatest(*expressions, **extra) +.. versionadded:: 1.9 + Accepts a list of at least two field names or expressions and returns the -greatest value. Each argument must be of a similar type, so mixing text and numbers -will result in a database error. +greatest value. Each argument must be of a similar type, so mixing text and +numbers will result in a database error. Usage example:: @@ -121,8 +121,8 @@ Usage example:: >>> comments = Comment.objects.annotate(last_updated=Greatest('modified', 'blog__modified')) >>> annotated_comment = comments.get() -``annotated_comment.last_updated`` will be the most recent of -``blog.modified`` and ``comment.modified``. +``annotated_comment.last_updated`` will be the most recent of ``blog.modified`` +and ``comment.modified``. .. warning:: @@ -131,19 +131,19 @@ Usage example:: - PostgreSQL: ``Greatest`` will return the largest non-null expression, or ``null`` if all expressions are ``null``. - - SQLite, Oracle and MySQL: If any expression is ``null``, ``Greatest`` + - SQLite, Oracle, and MySQL: If any expression is ``null``, ``Greatest`` will return ``null``. The PostgreSQL behavior can be emulated using ``Coalesce`` if you know a sensible minimum value to provide as a default. Least --------- - -.. versionadded:: 1.9 +----- .. class:: Least(*expressions, **extra) +.. versionadded:: 1.9 + Accepts a list of at least two field names or expressions and returns the least value. Each argument must be of a similar type, so mixing text and numbers will result in a database error. @@ -155,7 +155,7 @@ will result in a database error. - PostgreSQL: ``Least`` will return the smallest non-null expression, or ``null`` if all expressions are ``null``. - - SQLite, Oracle and MySQL: If any expression is ``null``, ``Least`` + - SQLite, Oracle, and MySQL: If any expression is ``null``, ``Least`` will return ``null``. The PostgreSQL behavior can be emulated using ``Coalesce`` if you know