summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorEd Henderson <ed@sharpertool.com>2016-06-02 12:56:13 -0700
committerTim Graham <timograham@gmail.com>2016-06-03 11:49:24 -0400
commit521772ff0779ced13f94a6ebcd96740a9eafbb1d (patch)
tree4acdfd2f0514a599ca50d32dc43f22bb944d8c80 /docs/topics
parent971adb9e9ceaf50ecfa72db1b357bb38150048ea (diff)
[1.10.x] Fixed #26021 -- Applied hanging indentation to docs.
Backport of 4a4d7f980e2a66756e1e424f7648dcd28ff765b7 from master
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/auth/customizing.txt5
-rw-r--r--docs/topics/auth/default.txt8
-rw-r--r--docs/topics/db/queries.txt6
-rw-r--r--docs/topics/email.txt66
-rw-r--r--docs/topics/forms/modelforms.txt27
-rw-r--r--docs/topics/http/shortcuts.txt8
-rw-r--r--docs/topics/i18n/timezones.txt5
-rw-r--r--docs/topics/i18n/translation.txt13
8 files changed, 96 insertions, 42 deletions
diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt
index 8dd938e59a..d12fa6a212 100644
--- a/docs/topics/auth/customizing.txt
+++ b/docs/topics/auth/customizing.txt
@@ -971,9 +971,10 @@ authentication app::
Creates and saves a superuser with the given email, date of
birth and password.
"""
- user = self.create_user(email,
+ user = self.create_user(
+ email,
password=password,
- date_of_birth=date_of_birth
+ date_of_birth=date_of_birth,
)
user.is_admin = True
user.save(using=self._db)
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index 7e6794a97b..12a5602b5a 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -249,9 +249,11 @@ in ``myapp``::
from django.contrib.contenttypes.models import ContentType
content_type = ContentType.objects.get_for_model(BlogPost)
- permission = Permission.objects.create(codename='can_publish',
- name='Can Publish Posts',
- content_type=content_type)
+ permission = Permission.objects.create(
+ codename='can_publish',
+ name='Can Publish Posts',
+ content_type=content_type,
+ )
The permission can then be assigned to a
:class:`~django.contrib.auth.models.User` via its ``user_permissions``
diff --git a/docs/topics/db/queries.txt b/docs/topics/db/queries.txt
index 57408ee224..b1f1f2f746 100644
--- a/docs/topics/db/queries.txt
+++ b/docs/topics/db/queries.txt
@@ -849,14 +849,16 @@ precede the definition of any keyword arguments. For example::
Poll.objects.get(
Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6)),
- question__startswith='Who')
+ question__startswith='Who',
+ )
... would be a valid query, equivalent to the previous example; but::
# INVALID QUERY
Poll.objects.get(
question__startswith='Who',
- Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6)))
+ Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6))
+ )
... would not be valid.
diff --git a/docs/topics/email.txt b/docs/topics/email.txt
index e26bfb3535..2b880e0ba9 100644
--- a/docs/topics/email.txt
+++ b/docs/topics/email.txt
@@ -20,8 +20,13 @@ In two lines::
from django.core.mail import send_mail
- send_mail('Subject here', 'Here is the message.', 'from@example.com',
- ['to@example.com'], fail_silently=False)
+ send_mail(
+ 'Subject here',
+ 'Here is the message.',
+ 'from@example.com',
+ ['to@example.com'],
+ fail_silently=False,
+ )
Mail is sent using the SMTP host and port specified in the
:setting:`EMAIL_HOST` and :setting:`EMAIL_PORT` settings. The
@@ -149,8 +154,12 @@ Examples
This sends a single email to john@example.com and jane@example.com, with them
both appearing in the "To:"::
- send_mail('Subject', 'Message.', 'from@example.com',
- ['john@example.com', 'jane@example.com'])
+ send_mail(
+ 'Subject',
+ 'Message.',
+ 'from@example.com',
+ ['john@example.com', 'jane@example.com'],
+ )
This sends a message to john@example.com and jane@example.com, with them both
receiving a separate email::
@@ -281,9 +290,15 @@ For example::
from django.core.mail import EmailMessage
- email = EmailMessage('Hello', 'Body goes here', 'from@example.com',
- ['to1@example.com', 'to2@example.com'], ['bcc@example.com'],
- reply_to=['another@example.com'], headers={'Message-ID': 'foo'})
+ email = EmailMessage(
+ 'Hello',
+ 'Body goes here',
+ 'from@example.com',
+ ['to1@example.com', 'to2@example.com'],
+ ['bcc@example.com'],
+ reply_to=['another@example.com'],
+ headers={'Message-ID': 'foo'},
+ )
The class has the following methods:
@@ -405,10 +420,14 @@ It can also be used as a context manager, which will automatically call
from django.core import mail
with mail.get_connection() as connection:
- mail.EmailMessage(subject1, body1, from1, [to1],
- connection=connection).send()
- mail.EmailMessage(subject2, body2, from2, [to2],
- connection=connection).send()
+ mail.EmailMessage(
+ subject1, body1, from1, [to1],
+ connection=connection,
+ ).send()
+ mail.EmailMessage(
+ subject2, body2, from2, [to2],
+ connection=connection,
+ ).send()
Obtaining an instance of an email backend
-----------------------------------------
@@ -592,15 +611,28 @@ manually open the connection, you can control when it is closed. For example::
connection.open()
# Construct an email message that uses the connection
- email1 = mail.EmailMessage('Hello', 'Body goes here', 'from@example.com',
- ['to1@example.com'], connection=connection)
+ email1 = mail.EmailMessage(
+ 'Hello',
+ 'Body goes here',
+ 'from@example.com',
+ ['to1@example.com'],
+ connection=connection,
+ )
email1.send() # Send the email
# Construct two more messages
- email2 = mail.EmailMessage('Hello', 'Body goes here', 'from@example.com',
- ['to2@example.com'])
- email3 = mail.EmailMessage('Hello', 'Body goes here', 'from@example.com',
- ['to3@example.com'])
+ email2 = mail.EmailMessage(
+ 'Hello',
+ 'Body goes here',
+ 'from@example.com',
+ ['to2@example.com'],
+ )
+ email3 = mail.EmailMessage(
+ 'Hello',
+ 'Body goes here',
+ 'from@example.com',
+ ['to3@example.com'],
+ )
# Send the two emails in a single call -
connection.send_messages([email2, email3])
diff --git a/docs/topics/forms/modelforms.txt b/docs/topics/forms/modelforms.txt
index 146b7503d0..df6bd6bd38 100644
--- a/docs/topics/forms/modelforms.txt
+++ b/docs/topics/forms/modelforms.txt
@@ -195,8 +195,10 @@ we'll discuss in a moment.)::
class AuthorForm(forms.Form):
name = forms.CharField(max_length=100)
- title = forms.CharField(max_length=3,
- widget=forms.Select(choices=TITLE_CHOICES))
+ title = forms.CharField(
+ max_length=3,
+ widget=forms.Select(choices=TITLE_CHOICES),
+ )
birth_date = forms.DateField(required=False)
class BookForm(forms.Form):
@@ -589,8 +591,12 @@ the field declaratively and setting its ``validators`` parameter::
For example, if the ``Article`` model looks like this::
class Article(models.Model):
- headline = models.CharField(max_length=200, null=True, blank=True,
- help_text="Use puns liberally")
+ headline = models.CharField(
+ max_length=200,
+ null=True,
+ blank=True,
+ help_text='Use puns liberally',
+ )
content = models.TextField()
and you want to do some custom validation for ``headline``, while keeping
@@ -598,8 +604,11 @@ the field declaratively and setting its ``validators`` parameter::
``ArticleForm`` like this::
class ArticleForm(ModelForm):
- headline = MyFormField(max_length=200, required=False,
- help_text="Use puns liberally")
+ headline = MyFormField(
+ max_length=200,
+ required=False,
+ help_text='Use puns liberally',
+ )
class Meta:
model = Article
@@ -1022,8 +1031,10 @@ formset::
def manage_authors(request):
AuthorFormSet = modelformset_factory(Author, fields=('name', 'title'))
if request.method == "POST":
- formset = AuthorFormSet(request.POST, request.FILES,
- queryset=Author.objects.filter(name__startswith='O'))
+ formset = AuthorFormSet(
+ request.POST, request.FILES,
+ queryset=Author.objects.filter(name__startswith='O'),
+ )
if formset.is_valid():
formset.save()
# Do something.
diff --git a/docs/topics/http/shortcuts.txt b/docs/topics/http/shortcuts.txt
index af2da254fb..705de11b69 100644
--- a/docs/topics/http/shortcuts.txt
+++ b/docs/topics/http/shortcuts.txt
@@ -66,8 +66,9 @@ MIME type :mimetype:`application/xhtml+xml`::
def my_view(request):
# View code here...
- return render(request, 'myapp/index.html', {"foo": "bar"},
- content_type="application/xhtml+xml")
+ return render(request, 'myapp/index.html', {
+ 'foo': 'bar',
+ }, content_type='application/xhtml+xml')
This example is equivalent to::
@@ -78,8 +79,7 @@ This example is equivalent to::
# View code here...
t = loader.get_template('myapp/index.html')
c = {'foo': 'bar'}
- return HttpResponse(t.render(c, request),
- content_type="application/xhtml+xml")
+ return HttpResponse(t.render(c, request), content_type='application/xhtml+xml')
``render_to_response()``
========================
diff --git a/docs/topics/i18n/timezones.txt b/docs/topics/i18n/timezones.txt
index 674edc1a19..7beffdea72 100644
--- a/docs/topics/i18n/timezones.txt
+++ b/docs/topics/i18n/timezones.txt
@@ -434,8 +434,9 @@ traceback by adding the following to your settings file::
import warnings
warnings.filterwarnings(
- 'error', r"DateTimeField .* received a naive datetime",
- RuntimeWarning, r'django\.db\.models\.fields')
+ 'error', r"DateTimeField .* received a naive datetime",
+ RuntimeWarning, r'django\.db\.models\.fields',
+ )
Fixtures
--------
diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt
index 3046d7ca3b..b1d1e8e3be 100644
--- a/docs/topics/i18n/translation.txt
+++ b/docs/topics/i18n/translation.txt
@@ -468,8 +468,10 @@ If the string contains exactly one unnamed placeholder, you can interpolate
directly with the ``number`` argument::
class MyForm(forms.Form):
- error_message = ungettext_lazy("You provided %d argument",
- "You provided %d arguments")
+ error_message = ungettext_lazy(
+ "You provided %d argument",
+ "You provided %d arguments",
+ )
def clean(self):
# ...
@@ -1843,8 +1845,11 @@ If you need more flexibility, you could also add a new argument to your custom
def add_arguments(self, parser):
super(Command, self).add_arguments(parser)
- parser.add_argument('--extra-keyword', dest='xgettext_keywords',
- action='append')
+ parser.add_argument(
+ '--extra-keyword',
+ dest='xgettext_keywords',
+ action='append',
+ )
def handle(self, *args, **options):
xgettext_keywords = options.pop('xgettext_keywords')