#16653: Clarify "Reversing admin URLs" in docu...
---------------------------+-------------------------------
 Reporter:  jedie          |          Owner:  nobody
     Type:  Uncategorized  |         Status:  new
Milestone:                 |      Component:  Documentation
  Version:  1.3            |       Severity:  Normal
 Keywords:                 |   Triage Stage:  Unreviewed
Has patch:  1              |  Easy pickings:  1
    UI/UX:  0              |
---------------------------+-------------------------------
 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.:


 {{{#!diff
 diff --git a/docs/ref/contrib/admin/index.txt
 b/docs/ref/contrib/admin/index.txt
 index beff94e..d8cdd3c 100644
 --- a/docs/ref/contrib/admin/index.txt
 +++ b/docs/ref/contrib/admin/index.txt
 @@ -1696,7 +1696,7 @@ accessible using Django's :ref:`URL reversing system
 <naming-url-patterns>`.
  The :class:`AdminSite` provides the following named URL patterns:

      ======================  ========================  =============
 -    Page                    URL name                  Parameters
 +    Page                    URL name                  args
      ======================  ========================  =============
      Index                   ``index``
      Logout                  ``logout``
 @@ -1706,10 +1706,15 @@ The :class:`AdminSite` provides the following
 named URL patterns:
      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``
 }}}

-- 
Ticket URL: <https://code.djangoproject.com/ticket/16653>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Reply via email to