summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2014-11-19 12:22:23 -0500
committerTim Graham <timograham@gmail.com>2015-01-17 08:40:23 -0500
commitc820892eed9ea10879270e64e8109dc44829756a (patch)
tree3edb914f3eeac75acb72bc60a94b991f9b211902 /docs
parent41f0d3d3bc8b0a6831530e1176c6415f9ba45b0b (diff)
Removed django.utils.datastructures.SortedDict per deprecation timeline.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/utils.txt28
-rw-r--r--docs/releases/1.0-porting-guide.txt4
-rw-r--r--docs/releases/1.7.txt3
-rw-r--r--docs/topics/python3.txt2
4 files changed, 4 insertions, 33 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 55184c277b..d1881bb830 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -97,34 +97,6 @@ need to distinguish caches by the ``Accept-language`` header.
cache, this just means that we have to build the response once to get at
the Vary header and so at the list of headers to use for the cache key.
-``django.utils.datastructures``
-===============================
-
-.. module:: django.utils.datastructures
- :synopsis: Data structures that aren't in Python's standard library.
-
-.. class:: SortedDict
-
-.. deprecated:: 1.7
- ``SortedDict`` is deprecated and will be removed in Django 1.9. Use
- :class:`collections.OrderedDict` instead.
-
- The :class:`django.utils.datastructures.SortedDict` class is a dictionary
- that keeps its keys in the order in which they're inserted.
-
-Creating a new SortedDict
--------------------------
-
-Creating a new ``SortedDict`` must be done in a way where ordering is
-guaranteed. For example::
-
- SortedDict({'b': 1, 'a': 2, 'c': 3})
-
-will not work. Passing in a basic Python ``dict`` could produce unreliable
-results. Instead do::
-
- SortedDict([('b', 1), ('a', 2), ('c', 3)])
-
``django.utils.dateparse``
==========================
diff --git a/docs/releases/1.0-porting-guide.txt b/docs/releases/1.0-porting-guide.txt
index a3c1a95702..a8b4ccaa26 100644
--- a/docs/releases/1.0-porting-guide.txt
+++ b/docs/releases/1.0-porting-guide.txt
@@ -714,12 +714,12 @@ Data structures
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``django.newforms.forms.SortedDictFromList`` was removed.
-:class:`django.utils.datastructures.SortedDict` can now be instantiated with
+``django.utils.datastructures.SortedDict`` can now be instantiated with
a sequence of tuples.
To update your code:
-1. Use :class:`django.utils.datastructures.SortedDict` wherever you were
+1. Use ``django.utils.datastructures.SortedDict`` wherever you were
using ``django.newforms.forms.SortedDictFromList``.
2. Because ``django.utils.datastructures.SortedDict.copy`` doesn't
diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt
index b5888bc52a..2592d64983 100644
--- a/docs/releases/1.7.txt
+++ b/docs/releases/1.7.txt
@@ -1511,8 +1511,7 @@ Python versions, this module isn't useful anymore. It has been deprecated. Use
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As :class:`~collections.OrderedDict` was added to the standard library in
-Python 2.7, :class:`~django.utils.datastructures.SortedDict` is no longer
-needed and has been deprecated.
+Python 2.7, ``SortedDict`` is no longer needed and has been deprecated.
Custom SQL location for models package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/topics/python3.txt b/docs/topics/python3.txt
index 2f12809163..5dc2cf464c 100644
--- a/docs/topics/python3.txt
+++ b/docs/topics/python3.txt
@@ -181,7 +181,7 @@ versions of Python.
:meth:`dict.keys`, :meth:`dict.items` and :meth:`dict.values` return lists in
Python 2 and iterators in Python 3. :class:`~django.http.QueryDict` and the
-:class:`dict`-like classes defined in :mod:`django.utils.datastructures`
+:class:`dict`-like classes defined in ``django.utils.datastructures``
behave likewise in Python 3.
six_ provides compatibility functions to work around this change: