summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBoulder Sprinters <boulder-sprinters@djangoproject.com>2007-04-27 20:21:28 +0000
committerBoulder Sprinters <boulder-sprinters@djangoproject.com>2007-04-27 20:21:28 +0000
commit3b479bfc563d3b3d768640ff5963947c56ee042b (patch)
tree2a7e3397d79244b516cef5268ee6f2df125ccf45 /docs
parentd0213969c226aa95d22b0f7ebf4bffef6fb20c48 (diff)
boulder-oracle-sprint: Merged to [5113]
git-svn-id: http://code.djangoproject.com/svn/django/branches/boulder-oracle-sprint@5114 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/email.txt14
-rw-r--r--docs/forms.txt20
-rw-r--r--docs/settings.txt5
3 files changed, 27 insertions, 12 deletions
diff --git a/docs/email.txt b/docs/email.txt
index 1f4ce4ef42..cbe909c03c 100644
--- a/docs/email.txt
+++ b/docs/email.txt
@@ -19,13 +19,23 @@ In two lines::
send_mail('Subject here', 'Here is the message.', 'from@example.com',
['to@example.com'], fail_silently=False)
-
+
+Mail will be sent using the SMTP host and port specified in the `EMAIL_HOST`_
+and `EMAIL_PORT`_ settings. The `EMAIL_HOST_USER`_ and `EMAIL_HOST_PASSWORD`_
+settings, if set, will be used to authenticate to the
+SMTP server.
+
.. note::
The character set of email sent with ``django.core.mail`` will be set to
the value of your `DEFAULT_CHARSET setting`_.
-
+
.. _DEFAULT_CHARSET setting: ../settings/#DEFAULT_CHARSET
+.. _EMAIL_HOST: ../settings/#EMAIL_HOST
+.. _EMAIL_PORT: ../settings/#EMAIL_PORT
+.. _EMAIL_HOST_USER: ../settings/#EMAIL_HOST_USER
+.. _EMAIL_HOST_PASSWORD: ../settings/#EMAIL_HOST_PASSWORD
+
send_mail()
===========
diff --git a/docs/forms.txt b/docs/forms.txt
index 144b70f13b..329e84a1b1 100644
--- a/docs/forms.txt
+++ b/docs/forms.txt
@@ -517,7 +517,7 @@ to put punctuation at the end of your validation messages.
When are validators called?
---------------------------
-After a form has been submitted, Django validates each field in turn. First,
+After a form has been submitted, Django validates each field in turn. First,
if the field is required, Django checks that it is present and non-empty. Then,
if that test passes *and the form submission contained data* for that field, all
the validators for that field are called in turn. The emphasized portion in the
@@ -615,15 +615,19 @@ fails. If no message is passed in, a default message is used.
``other_value``, then the validators in ``validator_list`` are all run
against the current field.
+``RequiredIfOtherFieldGiven``
+ Takes a field name of the current field is only required if the other
+ field has a value.
+
+``RequiredIfOtherFieldsGiven``
+ Similar to ``RequiredIfOtherFieldGiven``, except that it takes a list of
+ field names and if any one of the supplied fields has a value provided,
+ the current field being validated is required.
+
``RequiredIfOtherFieldNotGiven``
Takes the name of the other field and this field is only required if the
other field has no value.
-``RequiredIfOtherFieldsNotGiven``
- Similar to ``RequiredIfOtherFieldNotGiven``, except that it takes a list
- of field names and if any one of the supplied fields does not have a value
- provided, the field being validated is required.
-
``RequiredIfOtherFieldEquals`` and ``RequiredIfOtherFieldDoesNotEqual``
Each of these validator classes takes a field name and a value (in that
order). If the given field does (or does not have, in the latter case) the
@@ -650,8 +654,8 @@ fails. If no message is passed in, a default message is used.
``NumberIsInRange``
Takes two boundary numbers, ``lower`` and ``upper``, and checks that the
field is greater than ``lower`` (if given) and less than ``upper`` (if
- given).
-
+ given).
+
Both checks are inclusive. That is, ``NumberIsInRange(10, 20)`` will allow
values of both 10 and 20. This validator only checks numeric values
(e.g., float and integer values).
diff --git a/docs/settings.txt b/docs/settings.txt
index 9ab5f5ff82..583c258bd3 100644
--- a/docs/settings.txt
+++ b/docs/settings.txt
@@ -395,8 +395,9 @@ EMAIL_HOST_PASSWORD
Default: ``''`` (Empty string)
-Username to use for the SMTP server defined in ``EMAIL_HOST``. If empty,
-Django won't attempt authentication.
+Password to use for the SMTP server defined in ``EMAIL_HOST``. This setting is
+used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server.
+If either of these settings is empty, Django won't attempt authenticaion.
See also ``EMAIL_HOST_USER``.