#22220: reverse() documentation
------------------------------------------------+------------------------
               Reporter:  EvilDMP               |          Owner:  nobody
                   Type:  Cleanup/optimization  |         Status:  new
              Component:  Documentation         |        Version:  1.6
               Severity:  Normal                |       Keywords:
           Triage Stage:  Unreviewed            |      Has patch:  0
    Needs documentation:  0                     |    Needs tests:  0
Patch needs improvement:  0                     |  Easy pickings:  1
                  UI/UX:  0                     |
------------------------------------------------+------------------------
 https://docs.djangoproject.com/en/dev/ref/urlresolvers/#reverse:

 {{{
 reverse(viewname[, urlconf=None, args=None, kwargs=None,
 current_app=None])
 viewname is either the function name (either a function reference, or the
 string version of the name, if you used that form in urlpatterns) or the
 URL pattern name.
 }}}

 I think this could be clearer.

 * there should be a link to an example of each of the different ways in
 the documentation (only "URL pattern name" is elucidated this way)
 * the phrase "function reference" is confusing;
 https://docs.djangoproject.com/en/dev/topics/http/urls/#passing-callable-
 objects-instead-of-strings speaks of "passing objects" for example and the
 same language should be used in both cases.

 And what if one creates a URL pattern name that's the also the string
 version of the view function name - which would win?

-- 
Ticket URL: <https://code.djangoproject.com/ticket/22220>
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 unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/050.8bcdb9c677cab67702ffa054f44c8895%40djangoproject.com.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to