Skip to content

Mention type annotations in README #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mention type annotations in README #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Features
- Developed on Python 3.10
- Tested with CPython 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and PyPy3
- Tested on Linux, Mac OSX, and Windows
- Type annotations available

.. image:: https://github.com/grantjenks/python-sortedcontainers/workflows/integration/badge.svg
:target: http://www.grantjenks.com/docs/sortedcontainers/
Expand Down Expand Up @@ -141,6 +142,12 @@ Containers`_.
>>> help(SortedDict)
>>> help(SortedDict.popitem)

If you'd like type annotations, they're available by installing the
`sortedcontainers-stubs <https://pypi.org/project/sortedcontainers-stubs/>`_
package (maintained separately, by Sorted Container's users)::
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mainly mention it's maintained separately because the trust assumptions are different for the stubs package, and people could think it was part of this repo. Also it might avoid people opening issues here for type problems!


$ pip install sortedcontainers-stubs

Documentation
-------------

Expand Down