[Django] #31270: Documentation for RedirectView.get_redirect_url doesn't describe its arguments
Django
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.
Django
--------------------------------------+------------------------------------
Reporter: Baptiste Mispelon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.0
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by felixxm):
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:1>
Django
arguments.
--------------------------------------+------------------------------------
Reporter: Baptiste Mispelon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.0
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:2>
Django
arguments.
Reporter: Baptiste Mispelon | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Hasan Ramezani):
* owner: nobody => Hasan Ramezani
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:3>
Django
arguments.
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Hasan Ramezani):
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:4>
Django
arguments.
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by felixxm):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:5>
Django
arguments.
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Hasan
Type: | Ramezani
Component: Documentation | Version: 3.0
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"2ab97af3528352e8f3ea4aa725b863822442d5ed" 2ab97af]:
{{{
#!CommitTicketReference repository=""
revision="2ab97af3528352e8f3ea4aa725b863822442d5ed"
Fixed #31270 -- Doc'd RedirectView.get_redirect_url() arguments.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:6>
Django
arguments.
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"bcf58e3e705cf0feaf29768a3539b241d8f12ec8" bcf58e3e]:
{{{
#!CommitTicketReference repository=""
revision="bcf58e3e705cf0feaf29768a3539b241d8f12ec8"
[3.0.x] Fixed #31270 -- Doc'd RedirectView.get_redirect_url() arguments.
Backport of 2ab97af3528352e8f3ea4aa725b863822442d5ed from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/31270#comment:7>