Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#31270 closed Cleanup/optimization (fixed)

Documentation for RedirectView.get_redirect_url() doesn't describe its arguments.

Reported by: Baptiste Mispelon Owned by: Hasan Ramezani
Component: Documentation Version: 3.0
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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

Change History (7)

comment:1 by Mariusz Felisiak, 4 years ago

Summary: Documentation for RedirectView.get_redirect_url doesn't describe its arguments → Documentation for RedirectView.get_redirect_url doesn't describe its arguments.
Triage Stage: Unreviewed → Accepted

comment:2 by Mariusz Felisiak, 4 years ago

Summary: Documentation for RedirectView.get_redirect_url doesn't describe its arguments. → Documentation for RedirectView.get_redirect_url() doesn't describe its arguments.

comment:3 by Hasan Ramezani, 4 years ago

Owner: changed from nobody to Hasan Ramezani
Status: new → assigned

comment:4 by Hasan Ramezani, 4 years ago

Has patch: set

comment:5 by Mariusz Felisiak, 4 years ago

Triage Stage: Accepted → Ready for checkin

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 4 years ago

Resolution: → fixed
Status: assigned → closed

In 2ab97af:

Fixed #31270 -- Doc'd RedirectView.get_redirect_url() arguments.

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 4 years ago

In bcf58e3e:

[3.0.x] Fixed #31270 -- Doc'd RedirectView.get_redirect_url() arguments.

Backport of 2ab97af3528352e8f3ea4aa725b863822442d5ed from master

Note: See TracTickets for help on using tickets.
Back to Top