Ticket #13452: regroup-choices-2.diff

docs/ref/models/instances.txt

@@ -515 +515 @@
 More details on named URL patterns are in the :ref:`URL dispatch documentation
 <topics-http-urls>`.
 
+.. _extra-instance-methods:
+
 Extra instance methods
 ======================
 

docs/ref/templates/builtins.txt

@@ -825 +825 @@
 
     {% regroup people|dictsort:"gender" by gender as gender_list %}
 
+Note that *methods* are also valid arguments to the regroup tag. For
+example, if the "gender" field on the model in this example is a CHOICES
+field rather than a foreign key, ``{{ gender.grouper }}`` will naturally
+have a :ref:`get_FOO_display() <extra-instance-methods>` method
+available as an attribute, so you can group on the display string
+rather than the CHOICES key::
+
+    {% regroup people by get_gender_display as gender_list %}
+
+``{{ gender.grouper }}`` will now display the value fields from the
+CHOICES set rather than the keys.
+
 .. templatetag:: spaceless
 
 spaceless