Docs improve type hints #963
Merged
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
With `from __future__ import annotations` in the code, Sphinx gets easily confused. This applies to several areas like: * Type aliases * Things defined in `if typing.TYPE_CHECKING` blocks * Usage of the `typing_extensions` module This PR aims to work around as many of those quirks as possible.
thelonelyvulpes
approved these changes
Sep 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
With
from __future__ import annotationsin the code, Sphinx gets easilyconfused. This applies to several areas like:
if typing.TYPE_CHECKINGblockstyping_extensionsmoduleThis PR aims to work around as many of those quirks as possible.