summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-01-22 19:01:54 -0500
committerTim Graham <timograham@gmail.com>2016-03-05 11:00:12 -0500
commitc3e22ba78d1f6a780d1181cb16e3240136f2ae59 (patch)
tree9b8cb65ffc2a7a8797a294093240befd449c9aa2 /docs
parent9ed4a788aa8d6ba6a57a2daa15253c3047048dfb (diff)
downloaddjango-24046.tar.gz
Refs #24046 -- POC for mark_for_escaping() removal.24046
Diffstat (limited to 'docs')
-rw-r--r--docs/howto/custom-template-tags.txt9
-rw-r--r--docs/ref/utils.txt8
-rw-r--r--docs/releases/1.7.2.txt2
-rw-r--r--docs/topics/python3.txt12
4 files changed, 5 insertions, 26 deletions
diff --git a/docs/howto/custom-template-tags.txt b/docs/howto/custom-template-tags.txt
index 97179de7b0..69e223c01c 100644
--- a/docs/howto/custom-template-tags.txt
+++ b/docs/howto/custom-template-tags.txt
@@ -210,15 +210,6 @@ passed around inside the template code:
# Do something with the "safe" string.
...
-* **Strings marked as "needing escaping"** are *always* escaped on
- output, regardless of whether they are in an :ttag:`autoescape` block or
- not. These strings are only escaped once, however, even if auto-escaping
- applies.
-
- Internally, these strings are of type ``EscapeBytes`` or
- ``EscapeText``. Generally you don't have to worry about these; they
- exist for the implementation of the :tfilter:`escape` filter.
-
Template filter code falls into one of two situations:
1. Your filter does not introduce any HTML-unsafe characters (``<``, ``>``,
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 2a330ca953..c696627fc6 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -840,14 +840,6 @@ appropriate entities.
>>> type(mystr)
<type 'str'>
-.. function:: mark_for_escaping(s)
-
- 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/1.7.2.txt b/docs/releases/1.7.2.txt
index 040c983fcb..056f432978 100644
--- a/docs/releases/1.7.2.txt
+++ b/docs/releases/1.7.2.txt
@@ -177,7 +177,7 @@ Bugfixes
setup (:ticket:`24000`).
* Restored support for objects that aren't :class:`str` or :class:`bytes` in
- :func:`~django.utils.safestring.mark_for_escaping` on Python 3.
+ ``django.utils.safestring.mark_for_escaping()`` on Python 3.
* Supported strings escaped by third-party libraries with the ``__html__``
convention in the template engine (:ticket:`23831`).
diff --git a/docs/topics/python3.txt b/docs/topics/python3.txt
index 003dd0ebc5..c252e98d49 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.