Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #2071 -- documented the PasswordField (including cavaets). Than…

…ks to

asmodai for the initial patch.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@3184 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit c4fa8a158aa3ca0623c867ae67afc47b92277ed6 1 parent b70a687
@malcolmt malcolmt authored
Showing with 13 additions and 0 deletions.
  1. +13 −0 docs/model-api.txt
View
13 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``
~~~~~~~~~~~~~~~~~~~~
Please sign in to comment.
Something went wrong with that request. Please try again.