Commits

Anonymous committed ca8898f

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

Comments (0)

Files changed (1)

docs/model-api.txt

 
 The admin represents this as a ``<select>`` box with "Unknown", "Yes" and "No" choices.
 
+``PasswordField``
+~~~~~~~~~~~~~~~~~  
+
+A ``PasswordField`` is like a ``TextField`` but the characters that are
+entered are masked, typically by asterisks (*), when entered into a form. Note
+that though the data is masked on entry, it is sent as clear text to the
+server and stored as plain text in the database. Additional measures (such as
+using HTTPS) are needed to ensure the security of data sent from a form. This
+field is probably more useful when used in a `custom manipulator`_ than
+directly in a model.
+
+.. _custom manipulator: http://www.djangoproject.com/documentation/forms/#custom-forms-and-manipulators
+
 ``PhoneNumberField``
 ~~~~~~~~~~~~~~~~~~~~