summaryrefslogtreecommitdiff
path: root/docs/ref/forms
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-03-17 12:45:23 -0400
committerTim Graham <timograham@gmail.com>2016-03-19 18:01:10 -0400
commit53e8ab580f7c0fcfc589ba0b1b6cc2556080e0b2 (patch)
tree0b8e448e0cd7e4ec801f76f2ad9287e701939efb /docs/ref/forms
parent4c1c93032f4a015cbb4b33958603d18ac43515b4 (diff)
Fixed #26265 -- Clarified RadioSelect container's HTML id.
Diffstat (limited to 'docs/ref/forms')
-rw-r--r--docs/ref/forms/api.txt5
-rw-r--r--docs/ref/forms/widgets.txt8
2 files changed, 9 insertions, 4 deletions
diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt
index 631fe1ea54..f1c46da947 100644
--- a/docs/ref/forms/api.txt
+++ b/docs/ref/forms/api.txt
@@ -826,6 +826,11 @@ The field-specific output honors the form object's ``auto_id`` setting::
Attributes of ``BoundField``
----------------------------
+.. attribute:: BoundField.auto_id
+
+ The HTML ID attribute for this ``BoundField``. Returns an empty string
+ if :attr:`Form.auto_id` is ``False``.
+
.. attribute:: BoundField.data
This property returns the data for this :class:`~django.forms.BoundField`
diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt
index f456dcf622..e347876724 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -680,8 +680,8 @@ Selector and checkbox widgets
simply includes ``{{ myform.beatles }}`` -- they'll be output in a ``<ul>``
with ``<li>`` tags, as above.
- The outer ``<ul>`` container will receive the ``id`` attribute defined on
- the widget.
+ The outer ``<ul>`` container receives the ``id`` attribute of the widget,
+ if defined, or :attr:`BoundField.auto_id` otherwise.
When looping over the radio buttons, the ``label`` and ``input`` tags include
``for`` and ``id`` attributes, respectively. Each radio button has an
@@ -702,8 +702,8 @@ Selector and checkbox widgets
...
</ul>
- The outer ``<ul>`` container will receive the ``id`` attribute defined on
- the widget.
+ The outer ``<ul>`` container receives the ``id`` attribute of the widget,
+ if defined, or :attr:`BoundField.auto_id` otherwise.
Like :class:`RadioSelect`, you can now loop over the individual checkboxes making
up the lists. See the documentation of :class:`RadioSelect` for more details.