Typing: complete and enforce presence of return type annotations for public functions in main module #171
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
8040fed to
9b9815f
Compare
…public functions in main module; additional return type annotations in tests
Olen
approved these changes
Mar 10, 2025
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.
Building on #152, this PR:
Completes return hints for public functions, methods in the main module and enforces their presence, i.e. new code in the main module must have return types to pass CI. Some of these go along with what docstrings say is returned, not what may actually be returned. But sorting that is one for a different PR.
Adds additional return types in tests, but this is still incomplete and not enforced.
It should have zero runtime effect.
Note no actual type checking is enforced yet.