diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/forms/fields.txt | 6 | ||||
| -rw-r--r-- | docs/releases/6.1.txt | 6 |
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 8ddc5b9d79..6186f7d4e8 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -1619,12 +1619,16 @@ customize the yielded 2-tuple choices. ``ModelChoiceIterator`` has the following method: - .. method:: __iter__() + .. method:: generator() Yields 2-tuple choices, in the ``(value, label)`` format used by :attr:`ChoiceField.choices`. The first ``value`` element is a :class:`ModelChoiceIteratorValue` instance. + .. versionchanged:: 6.1 + + ``generator`` yields choices instead of ``__iter__``. + ``ModelChoiceIteratorValue`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/6.1.txt b/docs/releases/6.1.txt index 987d46874a..cc236b5ac2 100644 --- a/docs/releases/6.1.txt +++ b/docs/releases/6.1.txt @@ -264,6 +264,12 @@ Forms field's choices. This allows per-request refreshing when called in a form's ``__init__()``. +* :class:`~django.forms.ModelChoiceIterator` now yields choices via + its :meth:`~django.forms.ModelChoiceIterator.generator` method. + Users who have previously overridden the ``__iter__()`` method of + :class:`~django.forms.ModelChoiceIterator` should override + :meth:`~django.forms.ModelChoiceIterator.generator` instead. + Generic Views ~~~~~~~~~~~~~ |