summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-05-14 19:06:31 -0400
committerTim Graham <timograham@gmail.com>2016-05-14 19:07:39 -0400
commitdbd72b850b487be37df2940d16697a2d57b73ac6 (patch)
tree30783948c9aeb6216d5a43a3a9919b1b00af6d13 /docs
parent936a7df6520941e264f741766281fc00e4709a2d (diff)
[1.9.x] Refs #26021 -- Used hanging indentation in some doc examples.
Backport of e475e849703d937e158e75e7a6d9cb99090857f6 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/querysets.txt13
-rw-r--r--docs/ref/utils.txt22
-rw-r--r--docs/topics/db/queries.txt9
-rw-r--r--docs/topics/testing/tools.txt6
4 files changed, 30 insertions, 20 deletions
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt
index 92dbe803b6..1c488c7e33 100644
--- a/docs/ref/models/querysets.txt
+++ b/docs/ref/models/querysets.txt
@@ -931,8 +931,10 @@ For example, suppose you have these models::
toppings = models.ManyToManyField(Topping)
def __str__(self): # __unicode__ on Python 2
- return "%s (%s)" % (self.name, ", ".join(topping.name
- for topping in self.toppings.all()))
+ return "%s (%s)" % (
+ self.name,
+ ", ".join(topping.name or topping in self.toppings.all()),
+ )
and run::
@@ -1679,8 +1681,11 @@ This is meant as a shortcut to boilerplatish code. For example::
This pattern gets quite unwieldy as the number of fields in a model goes up.
The above example can be rewritten using ``get_or_create()`` like so::
- obj, created = Person.objects.get_or_create(first_name='John', last_name='Lennon',
- defaults={'birthday': date(1940, 10, 9)})
+ obj, created = Person.objects.get_or_create(
+ first_name='John',
+ last_name='Lennon',
+ defaults={'birthday': date(1940, 10, 9)},
+ )
Any keyword arguments passed to ``get_or_create()`` — *except* an optional one
called ``defaults`` — will be used in a :meth:`get()` call. If an object is
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 3d6b792263..7afa4504cc 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -323,7 +323,7 @@ Sample usage::
>>> feed.add_item(
... title="Hello",
... link="http://www.holovaty.com/test/",
- ... description="Testing."
+ ... description="Testing.",
... )
>>> with open('test.rss', 'w') as fp:
... feed.write(fp, 'utf-8')
@@ -601,15 +601,19 @@ escaping HTML.
So, instead of writing::
- mark_safe("%s <b>%s</b> %s" % (some_html,
- escape(some_text),
- escape(some_other_text),
- ))
+ mark_safe("%s <b>%s</b> %s" % (
+ some_html,
+ escape(some_text),
+ escape(some_other_text),
+ ))
You should instead use::
format_html("{} <b>{}</b> {}",
- mark_safe(some_html), some_text, some_other_text)
+ mark_safe(some_html),
+ some_text,
+ some_other_text,
+ )
This has the advantage that you don't need to apply :func:`escape` to each
argument and risk a bug and an XSS vulnerability if you forget one.
@@ -630,8 +634,10 @@ escaping HTML.
``args_generator`` should be an iterator that returns the sequence of
``args`` that will be passed to :func:`format_html`. For example::
- format_html_join('\n', "<li>{} {}</li>", ((u.first_name, u.last_name)
- for u in users))
+ format_html_join(
+ '\n', "<li>{} {}</li>",
+ ((u.first_name, u.last_name) for u in users)
+ )
.. function:: strip_tags(value)
diff --git a/docs/topics/db/queries.txt b/docs/topics/db/queries.txt
index 6d2cbd9175..0cb6b1db1f 100644
--- a/docs/topics/db/queries.txt
+++ b/docs/topics/db/queries.txt
@@ -519,8 +519,7 @@ will return ``Blog`` objects that have an empty ``name`` on the ``author`` and
also those which have an empty ``author`` on the ``entry``. If you don't want
those latter objects, you could write::
- Blog.objects.filter(entry__authors__isnull=False,
- entry__authors__name__isnull=True)
+ Blog.objects.filter(entry__authors__isnull=False, entry__authors__name__isnull=True)
Spanning multi-valued relationships
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -556,14 +555,12 @@ select all blogs that contain entries with both *"Lennon"* in the headline
and that were published in 2008 (the same entry satisfying both conditions),
we would write::
- Blog.objects.filter(entry__headline__contains='Lennon',
- entry__pub_date__year=2008)
+ Blog.objects.filter(entry__headline__contains='Lennon', entry__pub_date__year=2008)
To select all blogs that contain an entry with *"Lennon"* in the headline
**as well as** an entry that was published in 2008, we would write::
- Blog.objects.filter(entry__headline__contains='Lennon').filter(
- entry__pub_date__year=2008)
+ Blog.objects.filter(entry__headline__contains='Lennon').filter(entry__pub_date__year=2008)
Suppose there is only one blog that had both entries containing *"Lennon"* and
entries from 2008, but that none of the entries from 2008 contained *"Lennon"*.
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index f9a8bafa77..8890afcf08 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -1693,9 +1693,11 @@ and contents::
class EmailTest(TestCase):
def test_send_email(self):
# Send message.
- mail.send_mail('Subject here', 'Here is the message.',
+ mail.send_mail(
+ 'Subject here', 'Here is the message.',
'from@example.com', ['to@example.com'],
- fail_silently=False)
+ fail_silently=False,
+ )
# Test that one message has been sent.
self.assertEqual(len(mail.outbox), 1)