summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Christopher Henry <k@severian.com>2013-12-18 00:40:25 -0500
committerTim Graham <timograham@gmail.com>2013-12-18 12:38:00 -0500
commit6833773775fe135c38768418d31ec3f789d8f06f (patch)
treee531983316fb2d3cea9f242a4a62fe6c406ebbab /docs
parente4174da34ab239f04d9c79fec9822b01d63e453b (diff)
[1.5.x] Fixed #21632 -- Docs: Removed example with callable as query parameter
Using callables as query parameters is undocumented and not working, so this changes an example from the ForeignKey.limit_choices_to documentation that uses it. Backport of d34c8c338a from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/fields.txt11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 8de8f7a61e..187aeee06a 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1023,14 +1023,13 @@ define the details of how the relation works.
.. attribute:: ForeignKey.limit_choices_to
A dictionary of lookup arguments and values (see :doc:`/topics/db/queries`)
- that limit the available admin or ModelForm choices for this object. Use
- this with functions from the Python ``datetime`` module to limit choices of
- objects by date. For example::
+ that limit the available admin or :class:`ModelForm <django.forms.ModelForm>`
+ choices for this object. For example::
- limit_choices_to = {'pub_date__lte': datetime.date.today}
+ staff_member = models.ForeignKey(User, limit_choices_to={'is_staff': True})
- only allows the choice of related objects with a ``pub_date`` before the
- current date to be chosen.
+ causes the corresponding field on the ``ModelForm`` to list only ``Users``
+ that have ``is_staff=True``.
Instead of a dictionary this can also be a :class:`~django.db.models.Q`
object for more :ref:`complex queries <complex-lookups-with-q>`. However,