Skip to content

Commit 5d88f70

Browse files
committed
Update docs
1 parent 52564aa commit 5d88f70

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/api/advanced_configuration.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,12 @@ Must be defined if the :ref:`extra_grouping_fields` option has been set. This wi
121121
grouper_selector_option_label
122122
++++++++++++++++++++++++++++++
123123

124-
If the version table link is specified without a grouper param, a form with a dropdown of grouper objects will display. This setting defines how the labels of those groupers will display on the dropdown.
124+
If the version table link is specified without a grouper param, a form with a dropdown of grouper objects will display. By default, if the grouper object is registered with the
125+
admin and has a ``search_fields`` attribute, the dropdown will be an autocomplete
126+
field which will display the object's ``__str__`` method. This is the recommended
127+
method.
128+
129+
For models not registerd with the admin, or without search fields, this setting defines how the labels of those groupers will display on the dropdown (regular select field).
125130

126131

127132
.. code-block:: python

0 commit comments

Comments
 (0)