Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#22644 closed Cleanup/optimization (fixed)

NamedUrlWizardView's done_step_name purpose unclear

Reported by: anonymous Owned by: Sasha Romijn
Component: Documentation Version: 1.6
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 NamedUrlWizardView's "done_step_name" option is unclear. First of all, the documentation says that you have to pass that argument, when, in fact, it's optional. Also, it's not super obvious that the "done_step_name" argument's value should not be the name of an actual URL from the urls.py file. Its just not very clear what the purpose of the argument is.

Change History (8)

comment:1 by Sasha Romijn, 10 years ago

Owner: changed from nobody to Sasha Romijn
Status: new → assigned
Triage Stage: Unreviewed → Accepted
Type: Uncategorized → Cleanup/optimization

comment:2 by Sasha Romijn, 10 years ago

Easy pickings: set
Has patch: set
Owner: Sasha Romijn removed
Status: assigned → new

I completely agree. PR in ​https://github.com/django/django/pull/2676
I've also touched up other unclear parts of the documentation for this view.

comment:3 by Tim Graham, 10 years ago

Triage Stage: Accepted → Ready for checkin

comment:4 by Sasha Romijn, 10 years ago

Owner: set to Sasha Romijn
Status: new → assigned

comment:5 by Erik Romijn <eromijn@…>, 10 years ago

Resolution: → fixed
Status: assigned → closed

In 727d048f0991ccbd1564c6fb225ffbfd2f1a2102:

Fixed #22644 -- Clarified documentation for NamedUrlWizardView

comment:6 by Erik Romijn <eromijn@…>, 10 years ago

In bc2bfbadcc2b914613547abdc87241b2ae33fac2:

[1.7.x] Fixed #22644 -- Clarified documentation for NamedUrlWizardView

Backport of 727d048f0991ccbd1564c6fb225ffbfd2f1a2102 from master.

comment:7 by Erik Romijn <eromijn@…>, 10 years ago

In 91e03e81bbfee069dc7a4b6e23d4ac30731c65d0:

[1.6.x] Fixed #22644 -- Clarified documentation for NamedUrlWizardView

Backport of 727d048f0991ccbd1564c6fb225ffbfd2f1a2102 from master.

comment:8 by Erik Romijn <eromijn@…>, 10 years ago

In d5ca48245132dee7359b616cd4416242bc28eaaa:

[1.5.x] Fixed #22644 -- Clarified documentation for NamedUrlWizardView

Backport of 727d048f0991ccbd1564c6fb225ffbfd2f1a2102 from master.

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