Opened 18 years ago

Closed 17 years ago

Last modified 17 years ago

#2071 closed task (fixed)

[patch] PasswordField needs documentation

Reported by: jyrki.pulliainen@… Owned by: Jacob
Component: Documentation Version: dev
Severity: normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

PasswordField exists in code but doesn't exist in documentation, even search won't find it.
Something to point out that this exists would be good, because it propably is a quite frequently
used field

Attachments (1)

model-api.txt.diff​ (674 bytes ) - added by asmodai@… 18 years ago.
Describe how PasswordField works

Download all attachments as: .zip

Change History (11)

comment:1 by James Bennett, 18 years ago

Probably more useful, but wider in scope, would be documentation of all the field types available in django.forms.

comment:2 by asmodai@…, 18 years ago

Owner: changed from Jacob to anonymous
Status: new → assigned
Summary: PasswordField needs documentation → [patch] PasswordField needs documentation

Find attached a patch to document this field.

by asmodai@…, 18 years ago

Attachment: model-api.txt.diff​ added

Describe how PasswordField works

comment:3 by Malcolm Tredinnick, 18 years ago

Resolution: → fixed
Status: assigned → closed

(In [3184]) Fixed #2071 -- documented the PasswordField (including cavaets). Thanks to
asmodai for the initial patch.

comment:4 by Chris Beaven, 18 years ago

Resolution: fixed
Status: closed → reopened

Reverted by Adrian in [3189]. I think there's some confusion - this documentation is for django.forms.PasswordField.
Perhaps mixing it in with models-api isn't the best idea, but it still should be documented somewhere.

comment:5 by anonymous, 18 years ago

Owner: changed from anonymous to Jacob
Status: reopened → new

comment:6 by Chris Beaven, 18 years ago

Resolution: → duplicate
Status: new → closed

The patch in #61 provides a new PasswordField field and documentation for it. I'll close this as a duplicate, thanks asmodai for the initial documentation.

comment:7 by Malcolm Tredinnick, 18 years ago

Resolution: duplicate
Status: closed → reopened

Let's leave this open for the time being. It's not clear at the moment that #61 is totally correct, since it mixes presentation and representation. So this documentation might well still be used when we document form fields. I'll add a note to #61 to point out the connection as well.

comment:8 by Chris Beaven, 17 years ago

Triage Stage: Unreviewed → Ready for checkin

comment:9 by Jacob, 17 years ago

Resolution: → fixed
Status: reopened → closed

(In [4578]) Fixed #2071: added a smidge of docs on PasswordField. Thanks for the patch, asmodai.

comment:10 by Chris Beaven, 17 years ago

My bad :( This was reverted in [4579] because there's no such thing as a PasswordField database field type, it's only a form type and they are not documented (well, with newforms they probably will be)

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