From 9a279edc1cedecc65249b061bcb2797fe509a85b Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Fri, 1 Apr 2011 16:18:23 +0000 Subject: [PATCH] Fixed some ReST errors from e-mail -> email change in docs, and changed some docs that shouldn't have been changed (because translation strings haven't been converted yet) git-svn-id: http://code.djangoproject.com/svn/django/trunk@15968 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/howto/error-reporting.txt | 2 +- docs/ref/forms/api.txt | 10 +++++----- docs/ref/forms/fields.txt | 2 +- docs/ref/forms/validation.txt | 4 ++-- docs/ref/unicode.txt | 2 +- docs/releases/1.2-alpha-1.txt | 2 +- docs/releases/1.2.txt | 2 +- docs/topics/email.txt | 16 ++++++++-------- docs/topics/testing.txt | 2 +- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/howto/error-reporting.txt b/docs/howto/error-reporting.txt index 241bdc1a37..063f943894 100644 --- a/docs/howto/error-reporting.txt +++ b/docs/howto/error-reporting.txt @@ -1,5 +1,5 @@ Error reporting via email -========================== +========================= When you're running a public site you should always turn off the :setting:`DEBUG` setting. That will make your server run much faster, and will diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index bd8948cc08..070f9ef19a 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -105,7 +105,7 @@ Access the :attr:`~Form.errors` attribute to get a dictionary of error messages:: >>> f.errors - {'sender': [u'Enter a valid email address.'], 'subject': [u'This field is required.']} + {'sender': [u'Enter a valid e-mail address.'], 'subject': [u'This field is required.']} In this dictionary, the keys are the field names, and the values are lists of Unicode strings representing the error messages. The error messages are stored @@ -537,18 +537,18 @@ method you're using:: >>> print f.as_table() Subject: Message: - Sender: + Sender: Cc myself: >>> print f.as_ul()
  • Subject:
  • Message:
    • -
  • Sender:
    • +
  • Sender:
  • Cc myself:
    • >>> print f.as_p()

    Subject:

    Message:

    -

    +

    Sender:

    Cc myself:

    @@ -571,7 +571,7 @@ pass that in at construction time::
    This field is required.

    Subject:

    Message:

    -
    Enter a valid email address.
    +
    Enter a valid e-mail address.

    Sender:

    Cc myself:

    diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 73d8b02869..338a80655e 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -30,7 +30,7 @@ exception or returns the clean value:: >>> f.clean('invalid email address') Traceback (most recent call last): ... - ValidationError: [u'Enter a valid email address.'] + ValidationError: [u'Enter a valid e-mail address.'] Core field arguments -------------------- diff --git a/docs/ref/forms/validation.txt b/docs/ref/forms/validation.txt index d8f896deb2..23aa27d985 100644 --- a/docs/ref/forms/validation.txt +++ b/docs/ref/forms/validation.txt @@ -187,7 +187,7 @@ a look at Django's ``EmailField``:: class EmailField(CharField): default_error_messages = { - 'invalid': _(u'Enter a valid email address.'), + 'invalid': _(u'Enter a valid e-mail address.'), } default_validators = [validators.validate_email] @@ -200,7 +200,7 @@ on field definition so:: is equivalent to:: email = forms.CharField(validators=[validators.validate_email], - error_messages={'invalid': _(u'Enter a valid email address.')}) + error_messages={'invalid': _(u'Enter a valid e-mail address.')}) Form field default cleaning diff --git a/docs/ref/unicode.txt b/docs/ref/unicode.txt index bd11d2a4b8..2a13736b82 100644 --- a/docs/ref/unicode.txt +++ b/docs/ref/unicode.txt @@ -305,7 +305,7 @@ A couple of tips to remember when writing your own template tags and filters: strings at that point. Email -====== +===== Django's email framework (in ``django.core.mail``) supports Unicode transparently. You can use Unicode data in the message bodies and any headers. diff --git a/docs/releases/1.2-alpha-1.txt b/docs/releases/1.2-alpha-1.txt index 9fbee33615..ceb5daeffc 100644 --- a/docs/releases/1.2-alpha-1.txt +++ b/docs/releases/1.2-alpha-1.txt @@ -386,7 +386,7 @@ CSRF', where an attacking site tricks a user's browser into logging into a site with someone else's credentials, is also covered. Email Backends ---------------- +-------------- You can now :ref:`configure the way that Django sends email `. Instead of using SMTP to send all email, you diff --git a/docs/releases/1.2.txt b/docs/releases/1.2.txt index 6fef17596f..a289f6c1b6 100644 --- a/docs/releases/1.2.txt +++ b/docs/releases/1.2.txt @@ -185,7 +185,7 @@ The built-in :class:`~django.contrib.auth.models.User` model's of characters, including ``@``, ``+``, ``.`` and ``-`` characters. Email backends ---------------- +-------------- You can now :ref:`configure the way that Django sends email `. Instead of using SMTP to send all email, you diff --git a/docs/topics/email.txt b/docs/topics/email.txt index 65c5c7daef..bbb2c1f431 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -1,6 +1,6 @@ -============== +============= Sending email -============== +============= .. module:: django.core.mail :synopsis: Helpers to easily send email. @@ -364,8 +364,8 @@ subtype. For example:: .. _topic-email-backends: -E-Mail Backends -=============== +Email backends +============== .. versionadded:: 1.2 @@ -384,7 +384,7 @@ The email backend class has the following methods: left open after mail has been sent. Obtaining an instance of an email backend ------------------------------------------- +----------------------------------------- The :meth:`get_connection` function in ``django.core.mail`` returns an instance of the email backend that you can use. @@ -506,7 +506,7 @@ convenience that can be used during development. .. _topic-custom-email-backend: Defining a custom email backend --------------------------------- +------------------------------- If you need to change how emails are sent you can write your own email backend. The ``EMAIL_BACKEND`` setting in your settings file is then the @@ -524,7 +524,7 @@ implementation. .. _topics-sending-multiple-emails: Sending multiple emails ------------------------- +----------------------- Establishing and closing an SMTP connection (or any other network connection, for that matter) is an expensive process. If you have a lot of emails to send, @@ -580,7 +580,7 @@ manually open the connection, you can control when it is closed. For example:: Testing email sending -====================== +===================== There are times when you do not want Django to send emails at all. For example, while developing a Web site, you probably don't want diff --git a/docs/topics/testing.txt b/docs/topics/testing.txt index 67e1cf2a1c..64e4707350 100644 --- a/docs/topics/testing.txt +++ b/docs/topics/testing.txt @@ -1464,7 +1464,7 @@ cause of an failure in your test suite. .. _topics-testing-email: Email services ---------------- +-------------- If any of your Django views send email using :doc:`Django's email functionality `, you probably don't want to send email each time