Skip to content

Commit 1c25a38

Browse files
committed
Mention type annotations in README
The README now mentions and links to the `sortedcontainers-stubs` package, as discussed in grantjenks#107.
1 parent 1ed759b commit 1c25a38

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Features
114114
- Developed on Python 3.10
115115
- Tested with CPython 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and PyPy3
116116
- Tested on Linux, Mac OSX, and Windows
117+
- Type annotations available
117118

118119
.. image:: https://github.com/grantjenks/python-sortedcontainers/workflows/integration/badge.svg
119120
:target: http://www.grantjenks.com/docs/sortedcontainers/
@@ -141,6 +142,12 @@ Containers`_.
141142
>>> help(SortedDict)
142143
>>> help(SortedDict.popitem)
143144
145+
If you'd like type annotations, they're available by installing the
146+
`sortedcontainers-stubs <https://pypi.org/project/sortedcontainers-stubs/>`_
147+
package (maintained separately, by Sorted Container's users)::
148+
149+
$ pip install sortedcontainers-stubs
150+
144151
Documentation
145152
-------------
146153

0 commit comments

Comments
 (0)