Fixed #2071 -- documented the PasswordField (including cavaets). Thanks to

asmodai for the initial patch.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@3184 bcc190cf-cafb-0310-a4f2-bffc1f526a37

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/model-api.txt b/docs/model-api.txt
index 0dc98416a3..5934b7fdd0 100644
--- a/docs/model-api.txt
+++ b/docs/model-api.txt
@@ -322,6 +322,19 @@ instead of a ``BooleanField`` with ``null=True``.
 
 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``
 ~~~~~~~~~~~~~~~~~~~~