From 3c1ed1d336c847ed35934b3169632455505f4acb Mon Sep 17 00:00:00 2001
From: Pavel Kulikov <kulikovpavel@gmail.com>
Date: Sat, 11 Mar 2017 10:11:44 +0300
Subject: [PATCH] [1.11.x] Fixed #27918 -- Documented
 ChoiceWidget.option_template_name

Backport of 0d83052e52ddfe99c214be7ffca348a3c8feaef5 from master
---
 docs/ref/forms/widgets.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt
index f0301c1eee..b5d4fc3d5d 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -621,6 +621,14 @@ These widgets make use of the HTML elements ``input`` and ``textarea``.
 Selector and checkbox widgets
 -----------------------------
 
+These widgets make use of the HTML elements ``<select>``,
+``<input type='checkbox'>``, and ``<input type='radio'>``.
+
+Widgets that render multiple choices have an ``option_template_name`` attribute
+that specifies the template used to render each choice. For example, for the
+:class:`Select` widget, ``select_option.html`` renders the ``<option>`` for a
+``<select>``.
+
 ``CheckboxInput``
 ~~~~~~~~~~~~~~~~~
 
@@ -643,6 +651,7 @@ Selector and checkbox widgets
 .. class:: Select
 
     * ``template_name``: ``'django/forms/widgets/select.html'``
+    * ``option_template_name``: ``'django/forms/widgets/select_option.html'``
     * Renders as: ``<select><option ...>...</select>``
 
     .. attribute:: Select.choices
@@ -657,6 +666,7 @@ Selector and checkbox widgets
 .. class:: NullBooleanSelect
 
     * ``template_name``: ``'django/forms/widgets/select.html'``
+    * ``option_template_name``: ``'django/forms/widgets/select_option.html'``
 
     Select widget with options 'Unknown', 'Yes' and 'No'
 
@@ -666,6 +676,7 @@ Selector and checkbox widgets
 .. class:: SelectMultiple
 
     * ``template_name``: ``'django/forms/widgets/select.html'``
+    * ``option_template_name``: ``'django/forms/widgets/select_option.html'``
 
     Similar to :class:`Select`, but allows multiple selection:
     ``<select multiple='multiple'>...</select>``
@@ -676,6 +687,7 @@ Selector and checkbox widgets
 .. class:: RadioSelect
 
     * ``template_name``: ``'django/forms/widgets/radio.html'``
+    * ``option_template_name``: ``'django/forms/widgets/radio_option.html'``
 
     Similar to :class:`Select`, but rendered as a list of radio buttons within
     ``<li>`` tags:
@@ -770,6 +782,7 @@ Selector and checkbox widgets
 .. class:: CheckboxSelectMultiple
 
     * ``template_name``: ``'django/forms/widgets/checkbox_select.html'``
+    * ``option_template_name``: ``'django/forms/widgets/checkbox_option.html'``
 
     Similar to :class:`SelectMultiple`, but rendered as a list of check
     buttons: