summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2019-02-04 19:53:27 -0500
committerTim Graham <timograham@gmail.com>2019-02-05 12:58:55 -0500
commit41384812efe209c8295a50d78b45e0ffb2992436 (patch)
tree3814c1bd03c908697dea561f942a201be66f4aa2 /docs
parentefe28d3f566a00e76ae589a3f93be8079a638ca8 (diff)
Refs #27753 -- Removed django.utils.six.
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt2
-rw-r--r--docs/ref/utils.txt9
-rw-r--r--docs/releases/1.5.txt2
-rw-r--r--docs/releases/3.0.txt6
4 files changed, 7 insertions, 12 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 0550c10ec7..8172e2c8a7 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -774,8 +774,6 @@ details on these changes.
won't work after the upgrade.
* The ``django.utils.encoding.StrAndUnicode`` mix-in will be removed.
- Define a ``__str__`` method and apply the
- :func:`~django.utils.encoding.python_2_unicode_compatible` decorator instead.
.. _deprecation-removed-in-1.6:
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 300d4c1bea..23a4d6dedd 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -191,15 +191,6 @@ The functions defined in this module share the following properties:
.. module:: django.utils.encoding
:synopsis: A series of helper functions to manage character encoding.
-.. function:: python_2_unicode_compatible
-
- A decorator that defines ``__unicode__`` and ``__str__`` methods under
- Python 2. Under Python 3 it does nothing.
-
- To support Python 2 and 3 with a single code base, define a ``__str__``
- method returning text (use ``six.text_type()`` if you're doing some
- casting) and apply this decorator to the class.
-
.. function:: smart_text(s, encoding='utf-8', strings_only=False, errors='strict')
Returns a ``str`` object representing arbitrary object ``s``. Treats
diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt
index ed1990e30d..62f5e89633 100644
--- a/docs/releases/1.5.txt
+++ b/docs/releases/1.5.txt
@@ -783,7 +783,7 @@ If you rely on features added to ``simplejson`` after it became Python's
The ``django.utils.encoding.StrAndUnicode`` mix-in has been deprecated.
Define a ``__str__`` method and apply the
-:func:`~django.utils.encoding.python_2_unicode_compatible` decorator instead.
+``django.utils.encoding.python_2_unicode_compatible`` decorator instead.
``django.utils.itercompat.product``
-----------------------------------
diff --git a/docs/releases/3.0.txt b/docs/releases/3.0.txt
index 763c3ec5c0..c88a5c00ab 100644
--- a/docs/releases/3.0.txt
+++ b/docs/releases/3.0.txt
@@ -262,6 +262,12 @@ Django 3.0, we're removing these APIs at this time.
* ``django.utils._os.upath()`` and ``npath()`` - These functions do nothing on
Python 3.
+* ``django.utils.six`` - Remove usage of this vendored library or switch to
+ `six <https://pypi.org/project/six/>`_.
+
+* ``django.utils.encoding.python_2_unicode_compatible()`` - Alias of
+ ``six.python_2_unicode_compatible()``.
+
Miscellaneous
-------------