Finalizes typing and updates documentation #232
Merged
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
7 tasks
jcmgray
reviewed
May 21, 2024
There was a problem hiding this comment.
All seems good to me, though I don't really use mypy/types in python so not an expert.
For the test failures, I guess the py3.9 ones are to do with https://peps.python.org/pep-0604/.
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.
Description
The PR provides a comprehensive typing overhaul which should provide a fully consistent typing paradigm. Given we will remove numpy as a dependency shortly (#204) we have several constraints on the typing update to avoid the
np.typingmodule. While we can implementArrayTypeas aProtocol, I'm unsure it's worth the effort.Todos
Notable points that this PR has either accomplished or will accomplish.
Status