Opened 6 years ago

Closed 5 years ago

Last modified 5 years ago

#15949 closed Bug (fixed)

documentation for view password_reset_done needs changing.

Reported by: cyclops@… Owned by: Horst Gutmann <zerok@…>
Component: Documentation Version: 1.3
Severity: Normal Keywords: dceu2011
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

http://docs.djangoproject.com/en/1.3/topics/auth/#django.contrib.auth.views.password_reset_done

The text reads:

"The page shown after a user has reset their password."

A better wording would be:

"The page shown after a user has been emailed a link to reset their password. This view is called by default, if the view password_reset was not supplied a post_reset_redirect URL.

The exact same change applies to versions 1.2 and development branch.

Attachments (1)

ticket-15949.diff (588 bytes) - added by Horst Gutmann <zerok@…> 6 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 6 years ago by Jonas H.

Triage Stage: UnreviewedAccepted
Type: Cleanup/optimizationBug

(plus password_reset_done is a bad name)

comment:2 Changed 6 years ago by cyclops@…

I agree that password_reset_done is a bad name. However, fixing that would require changing code, whereas my suggestion only involved a documentation change. I wasn't clear on how much or what, should be put into a ticket, but it seemed like a pure text-only change would be simpler.

comment:3 Changed 6 years ago by Horst Gutmann <zerok@…>

Owner: changed from nobody to Horst Gutmann <zerok@…>
UI/UX: unset

Changed 6 years ago by Horst Gutmann <zerok@…>

Attachment: ticket-15949.diff added

comment:4 Changed 6 years ago by Horst Gutmann <zerok@…>

Has patch: set

comment:5 Changed 6 years ago by Chris Wesseling

Keywords: dceu2011 added
Triage Stage: AcceptedReady for checkin

Build the docs without problems and it looks OK.
Describes the behaviour.

comment:6 Changed 5 years ago by Tim Graham

Resolution: fixed
Status: newclosed

In [16378]:

Fixed #15949 - Clarified the docs for password_reset_done view; thanks cyclops for the suggestion; Horst Gutmann for the patch.

comment:7 Changed 5 years ago by Tim Graham

In [16379]:

[1.3.X] Fixed #15949 - Clarified the docs for password_reset_done view; thanks cyclops for the suggestion; Horst Gutmann for the patch.

Backport of r16378 from trunk.

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