Fixed #2071: added a smidge of docs on PasswordField. Thanks for the patch, asmodai.

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

1 files changed, 8 insertions, 0 deletions

diff --git a/docs/model-api.txt b/docs/model-api.txt
index 0a10918d54..53c0c21750 100644
--- a/docs/model-api.txt
+++ b/docs/model-api.txt
@@ -338,6 +338,14 @@ 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 difference is that the
+characters that are entered are masked, typically by asterisks (*). Also note
+that even though this is a password field the data is sent as clear text to
+the server. Additional measures are needed to ensure data safety.
+
 ``PhoneNumberField``
 ~~~~~~~~~~~~~~~~~~~~