#31270: Documentation for RedirectView.get_redirect_url doesn't describe its
arguments
------------------------------------------------+------------------------
               Reporter:  Baptiste Mispelon     |          Owner:  nobody
                   Type:  Cleanup/optimization  |         Status:  new
              Component:  Documentation         |        Version:  3.0
               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                     |
------------------------------------------------+------------------------
 The documentation for `RedirectView.get_redirect_url()` [1] shows that the
 method takes `*args, **kwargs` as arguments but doesn't explain what those
 are exactly.

 I had to look at the code to be sure: `args` and `kwargs` are the groups
 captured in the URL. That's what I expected and it might be obvious but I
 still think it should be mentioned in this reference documentation.

 I don't have immediate plans to work on this, anyone can pick this up. The
 file to modify is in `docs/ref/class-based-views/base.txt` [2].


 [1] https://docs.djangoproject.com/en/dev/ref/class-based-
 views/base/#django.views.generic.base.RedirectView.get_redirect_url
 [2] https://github.com/django/django/blob/master/docs/ref/class-based-
 views/base.txt#L259

-- 
Ticket URL: <https://code.djangoproject.com/ticket/31270>
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 [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/052.8516d92e5fb4f6cdb90ec44ddaf45349%40djangoproject.com.

Reply via email to