Refs #26021 -- Used hanging indentation in some doc examples.

This commit is contained in:
Tim Graham 2016-05-14 19:06:31 -04:00
parent 5238af3257
commit e475e84970
4 changed files with 30 additions and 20 deletions

View file

@ -921,8 +921,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::
@ -1669,8 +1671,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

View file

@ -317,7 +317,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')
@ -629,15 +629,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.
@ -658,8 +662,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)