Document kwargs support for urlresolvers.resolve

[jedie]

The section "Reversing admin URLs" on the page ​https://docs.djangoproject.com/en/1.3/ref/contrib/admin/#reversing-admin-urls should IMHO clarify that the parameters must be used as the keyword argument "args", e.g.:

docs/ref/contrib/admin/index.txt

@@ -1696 +1696 @@
 The :class:`AdminSite` provides the following named URL patterns:
 
     ======================  ========================  =============
-    Page                    URL name                  Parameters
+    Page                    URL name                  args
     ======================  ========================  =============
     Index                   ``index``
     Logout                  ``logout``
@@ -1706 +1706 @@
     Application index page  ``app_list``              ``app_label``
     ======================  ========================  =============
 
+Example go get the index page of the auth contrib app::
+
+    >>> from django.core import urlresolvers
+    >>> app_index_url = urlresolvers.reverse('admin:app_list', args=('auth',))
+
 Each :class:`ModelAdmin` instance provides an additional set of named URLs:
 
     ======================  ===============================================   =============
-    Page                    URL name                                          Parameters
+    Page                    URL name                                          args
     ======================  ===============================================   =============
     Changelist              ``{{ app_label }}_{{ model_name }}_changelist``
     Add                     ``{{ app_label }}_{{ model_name }}_add``

[jedie]

Hm. We can use "Parameters" as args and as kwargs. So renaming "Parameters" to "args" ist wrong.

But for clarify it's IMHO usefull we have a example which used 'kwargs' (There is already an example with 'args').

I would suggest this:

docs/ref/contrib/admin/index.txt

@@ -1706 +1706 @@
     Application index page  ``app_list``              ``app_label``
     ======================  ========================  =============
 
+Example go get the index page of the auth contrib app::
+
+    >>> from django.core import urlresolvers
+    >>> app_index_url = urlresolvers.reverse('admin:app_list', kwargs={'app_label': 'auth'})
+
 Each :class:`ModelAdmin` instance provides an additional set of named URLs:
 
     ======================  ===============================================   =============

[Julien Phalip]

I agree that kwargs support should be documented, but the best place for it probably is in ​https://docs.djangoproject.com/en/dev/topics/http/urls/#django.core.urlresolvers.reverse, since the admin doc already links to it anyway.

[Tim Graham]

In [17517]:

Fixed #16653 - Added example of kwargs support for resolve(); thanks krzysiumed for the patch.

[Tim Graham]

In [17518]:

Fixed #16653 - Added example of kwargs support for resolve(); thanks krzysiumed for the patch.

Backport of r17517 from trunk.