diff options
| author | Tim Graham <timograham@gmail.com> | 2019-02-05 09:19:49 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2019-02-06 14:12:06 -0500 |
| commit | d55e88292723764a16f0689c73bc7e739dfa6047 (patch) | |
| tree | b089db0867f0439b7998cf03c7cd0de28f4362f9 /docs | |
| parent | 3bb6a4390c0a57da991fcb1c0642b9b3fccff751 (diff) | |
Refs #27753 -- Deprecated django.utils.encoding.force_text() and smart_text().
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 2 | ||||
| -rw-r--r-- | docs/ref/utils.txt | 4 | ||||
| -rw-r--r-- | docs/releases/3.0.txt | 8 |
3 files changed, 14 insertions, 0 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 8172e2c8a7..4f9296bce8 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -18,6 +18,8 @@ details on these changes. * ``django.utils.http.urlquote()``, ``urlquote_plus()``, ``urlunquote()``, and ``urlunquote_plus()`` will be removed. +* ``django.utils.encoding.force_text()`` and ``smart_text()`` will be removed. + .. _deprecation-removed-in-3.1: 3.1 diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index 62625cf62c..9621db525b 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -232,11 +232,15 @@ The functions defined in this module share the following properties: .. function:: smart_text(s, encoding='utf-8', strings_only=False, errors='strict') + .. deprecated:: 3.0 + Alias of :func:`force_str` for backwards compatibility, especially in code that supports Python 2. .. function:: force_text(s, encoding='utf-8', strings_only=False, errors='strict') + .. deprecated:: 3.0 + Alias of :func:`force_str` for backwards compatibility, especially in code that supports Python 2. diff --git a/docs/releases/3.0.txt b/docs/releases/3.0.txt index eb02f19121..6c5eb0ccb5 100644 --- a/docs/releases/3.0.txt +++ b/docs/releases/3.0.txt @@ -292,6 +292,14 @@ Miscellaneous Features deprecated in 3.0 ========================== +``django.utils.encoding.force_text()`` and ``smart_text()`` +----------------------------------------------------------- + +The ``smart_text()`` and ``force_text()`` aliases (since Django 2.0) of +``smart_str()`` and ``force_str()`` are deprecated. Ignore this deprecation if +your code supports Python 2 as the behavior of ``smart_str()`` and +``force_str()`` is different there. + Miscellaneous ------------- |