Add py.typed file so that typecheckers recognize this library as typed #194
Conversation
This file contains hidden or 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
This is necessary as type-checking tools like mypy, pyright and ty use this file as described by PEP-0561 to recognize typed libraries. This is useful for better DX where, when types are available, they may enhance autocompletion and/or provide early warnings of invalid code. I would also recommend adding, if possible, types to the non-generated parts of the code (like the GhApi class for example). Closes AnswerDotAI#178.
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.
This is necessary as type-checking tools like mypy, pyright and ty use
this file as described by PEP-0561 to recognize typed libraries. This
is useful for better DX where, when types are available, they may
enhance autocompletion and/or provide early warnings of invalid code.
I would also recommend adding, if possible, types to the non-generated
parts of the code (like the GhApi class for example).
Closes #178.