Changeset 3184

Timestamp:

06/20/06 23:49:12 (2 years ago)

Author:

mtredinnick

Message:

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

Files:

• django/trunk/docs/model-api.txt (modified) (1 diff)

django/trunk/docs/model-api.txt

@@ -322 +322 @@
-
-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``