summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-12-31 12:43:30 -0500
committerTim Graham <timograham@gmail.com>2017-01-17 20:52:04 -0500
commit60ca37d2e56e435521a4aa5ba56b1b11cb2a78e5 (patch)
tree19fed3a6c8411aef6892b22032f4325014c78ee7 /docs
parent0dfc5479a8e50215866bbf43604bed8416a1b504 (diff)
Refs #24046 -- Removed mark_for_escaping() per deprecation timeline.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/templates/builtins.txt11
-rw-r--r--docs/ref/utils.txt10
-rw-r--r--docs/releases/2.0.txt6
-rw-r--r--docs/topics/python3.txt12
4 files changed, 10 insertions, 29 deletions
diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt
index 6395f97607..5925370843 100644
--- a/docs/ref/templates/builtins.txt
+++ b/docs/ref/templates/builtins.txt
@@ -1636,11 +1636,6 @@ Escapes a string's HTML. Specifically, it makes these replacements:
* ``"`` (double quote) is converted to ``&quot;``
* ``&`` is converted to ``&amp;``
-The escaping is only applied when the string is output, so it does not matter
-where in a chained sequence of filters you put ``escape``: it will always be
-applied as though it were the last filter. If you want escaping to be applied
-immediately, use the :tfilter:`force_escape` filter.
-
Applying ``escape`` to a variable that would normally have auto-escaping
applied to the result will only result in one round of escaping being done. So
it is safe to use this function even in auto-escaping environments. If you want
@@ -1652,12 +1647,6 @@ For example, you can apply ``escape`` to fields when :ttag:`autoescape` is off::
{{ title|escape }}
{% endautoescape %}
-.. deprecated:: 1.10
-
- The "lazy" behavior of the ``escape`` filter is deprecated. It will change
- to immediately apply :func:`~django.utils.html.conditional_escape` in
- Django 2.0.
-
.. templatefilter:: escapejs
``escapejs``
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 5870c955f6..8beafb8268 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -841,16 +841,6 @@ appropriate entities.
Added support for decorator usage.
-.. function:: mark_for_escaping(s)
-
- .. deprecated:: 1.10
-
- Explicitly mark a string as requiring HTML escaping upon output. Has no
- effect on ``SafeData`` subclasses.
-
- Can be called multiple times on a single string (the resulting escaping is
- only applied once).
-
``django.utils.text``
=====================
diff --git a/docs/releases/2.0.txt b/docs/releases/2.0.txt
index dade7e0bda..7e595e9cbf 100644
--- a/docs/releases/2.0.txt
+++ b/docs/releases/2.0.txt
@@ -378,3 +378,9 @@ these features.
* ``FileField`` methods ``get_directory_name()`` and ``get_filename()`` are
removed.
+
+* The ``mark_for_escaping()`` function and the classes it uses: ``EscapeData``,
+ ``EscapeBytes``, ``EscapeText``, ``EscapeString``, and ``EscapeUnicode`` are
+ removed.
+
+* The ``escape`` filter now uses ``django.utils.html.conditional_escape()``.
diff --git a/docs/topics/python3.txt b/docs/topics/python3.txt
index 04a975d8f2..9dd4d83732 100644
--- a/docs/topics/python3.txt
+++ b/docs/topics/python3.txt
@@ -112,22 +112,18 @@ For forwards compatibility, the new names work as of Django 1.4.2.
information.
:mod:`django.utils.safestring` is mostly used via the
-:func:`~django.utils.safestring.mark_safe` and
-:func:`~django.utils.safestring.mark_for_escaping` functions, which didn't
-change. In case you're using the internals, here are the name changes:
+:func:`~django.utils.safestring.mark_safe` function, which didn't change. In
+case you're using the internals, here are the name changes:
================== ==================
Old name New name
================== ==================
-``EscapeString`` ``EscapeBytes``
-``EscapeUnicode`` ``EscapeText``
``SafeString`` ``SafeBytes``
``SafeUnicode`` ``SafeText``
================== ==================
-For backwards compatibility, the old names still work on Python 2. Under
-Python 3, ``EscapeString`` and ``SafeString`` are aliases for ``EscapeText``
-and ``SafeText`` respectively.
+For backwards compatibility, the old names still work on Python 2. On Python 3,
+``SafeString`` is an alias for ``SafeText``.
For forwards compatibility, the new names work as of Django 1.4.2.