Code

Opened 8 years ago

Closed 7 years ago

Last modified 7 years ago

#2071 closed task (fixed)

[patch] PasswordField needs documentation

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

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@… 8 years ago.
Describe how PasswordField works

Download all attachments as: .zip

Change History (11)

comment:1 Changed 8 years ago by ubernostrum

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

comment:2 Changed 8 years ago by asmodai@…

  • Owner changed from jacob to anonymous
  • Status changed from new to assigned
  • Summary changed from PasswordField needs documentation to [patch] PasswordField needs documentation

Find attached a patch to document this field.

Changed 8 years ago by asmodai@…

Describe how PasswordField works

comment:3 Changed 8 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from assigned to closed

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

comment:4 Changed 8 years ago by SmileyChris

  • Resolution fixed deleted
  • Status changed from closed to 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 Changed 8 years ago by anonymous

  • Owner changed from anonymous to jacob
  • Status changed from reopened to new

comment:6 Changed 8 years ago by SmileyChris

  • Resolution set to duplicate
  • Status changed from new to 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 Changed 8 years ago by mtredinnick

  • Resolution duplicate deleted
  • Status changed from closed to 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 Changed 7 years ago by SmileyChris

  • Triage Stage changed from Unreviewed to Ready for checkin

comment:9 Changed 7 years ago by jacob

  • Resolution set to fixed
  • Status changed from reopened to closed

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

comment:10 Changed 7 years ago by SmileyChris

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)

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.