Skip to content

Commit c723c10

Browse files
committed
Update release history with link from intro
1 parent ddfbb45 commit c723c10

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

HISTORY.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
Sorted Containers Release History
22
=================================
33

4+
.. contents::
5+
:depth: 1
6+
:local:
7+
48
.. currentmodule:: sortedcontainers
59

10+
.. _v2:
11+
612
2.0.0 (2018-05-04)
713
------------------
814

docs/introduction.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -749,8 +749,7 @@ couple of things to keep in mind.
749749

750750
:doc:`Sorted Containers<index>` went through a major version change between
751751
version one and version two. The goal of the change was to adopt Python 3
752-
semantics wherever possible. These changes are detailed on the :doc:`history
753-
<history>` page but a quick summary follows:
752+
semantics wherever possible:
754753

755754
1. Several :class:`SortedList` methods now raise :exc:`NotImplementedError`:
756755
:func:`SortedList.__setitem__`, :func:`SortedList.append`, and
@@ -768,6 +767,10 @@ semantics wherever possible. These changes are detailed on the :doc:`history
768767
to `SortedKeyList` but an alias remains for compatibility. Several methods
769768
which accepted a `val` parameter now accept `value` for better readability.
770769

770+
The :doc:`history` documents all the changes made in every version in the
771+
history of the project. The :ref:`Version 2<v2>` release notes detail all the
772+
changes made.
773+
771774
The `blist`_ project remains the most similar as its API was the original
772775
inspiration for :doc:`Sorted Containers<index>`. The main difference has always
773776
been the :func:`SortedList.pop` method. The `blist`_ project pops the first

0 commit comments

Comments
 (0)