Fixed #4658 -- Improved documentation of linebreaks and linebreaksbr. Thanks, ubernostrum and Gary Wilson
git-svn-id: http://code.djangoproject.com/svn/django/trunk@6223 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
b522469322
commit
cadc6e8c9f
|
@ -254,13 +254,20 @@ def escape(value):
|
||||||
escape = stringfilter(escape)
|
escape = stringfilter(escape)
|
||||||
|
|
||||||
def linebreaks(value):
|
def linebreaks(value):
|
||||||
"Converts newlines into <p> and <br />s"
|
"""
|
||||||
|
Replaces line breaks in plain text with appropriate HTML; a single
|
||||||
|
newline becomes an HTML line break (``<br />``) and a new line
|
||||||
|
followed by a blank line becomes a paragraph break (``</p>``).
|
||||||
|
"""
|
||||||
from django.utils.html import linebreaks
|
from django.utils.html import linebreaks
|
||||||
return linebreaks(value)
|
return linebreaks(value)
|
||||||
linebreaks = stringfilter(linebreaks)
|
linebreaks = stringfilter(linebreaks)
|
||||||
|
|
||||||
def linebreaksbr(value):
|
def linebreaksbr(value):
|
||||||
"Converts newlines into <br />s"
|
"""
|
||||||
|
Converts all newlines in a piece of plain text to HTML line breaks
|
||||||
|
(``<br />``).
|
||||||
|
"""
|
||||||
return value.replace('\n', '<br />')
|
return value.replace('\n', '<br />')
|
||||||
linebreaksbr = stringfilter(linebreaksbr)
|
linebreaksbr = stringfilter(linebreaksbr)
|
||||||
|
|
||||||
|
|
|
@ -1135,12 +1135,15 @@ Returns a boolean of whether the value's length is the argument.
|
||||||
linebreaks
|
linebreaks
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
Converts newlines into ``<p>`` and ``<br />`` tags.
|
Replaces line breaks in plain text with appropriate HTML; a single
|
||||||
|
newline becomes an HTML line break (``<br />``) and a new line
|
||||||
|
followed by a blank line becomes a paragraph break (``</p>``).
|
||||||
|
|
||||||
linebreaksbr
|
linebreaksbr
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
Converts newlines into ``<br />`` tags.
|
Converts all newlines in a piece of plain text to HTML line breaks
|
||||||
|
(``<br />``).
|
||||||
|
|
||||||
linenumbers
|
linenumbers
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
Loading…
Reference in New Issue