Mention type annotations in README #231
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The README now mentions and links to the `sortedcontainers-stubs` package, as discussed in grantjenks#107.
h4l
commented
Mar 1, 2024
| @@ -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):: | |||
There was a problem hiding this comment.
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!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README now mentions and links to the
sortedcontainers-stubspackage, as discussed in #107.