Add support for Python type parameter lists #366
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
jbms
force-pushed
the
feat-python-type-parameters
branch
from
a11336f to
3da9c2d
Compare
|
This is basically feature complete but still needs some work on documentation and testing. |
jbms
force-pushed
the
feat-python-type-parameters
branch
3 times, most recently
from
ea315d9 to
4d8f8d5
Compare
|
The build failure due to undefined reference |
jbms
force-pushed
the
feat-python-type-parameters
branch
from
4d8f8d5 to
fd8029d
Compare
jbms
force-pushed
the
feat-python-type-parameters
branch
2 times, most recently
from
b3dea3a to
28ef75d
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #366 +/- ##
==========================================
- Coverage 63.03% 63.00% -0.03%
==========================================
Files 67 68 +1
Lines 8207 8502 +295
==========================================
+ Hits 5173 5357 +184
- Misses 3034 3145 +111 ☔ View full report in Codecov by Sentry. |
|
CI now passes. |
2bndy5
reviewed
Jul 20, 2024
2bndy5
reviewed
Jul 20, 2024
jbms
force-pushed
the
feat-python-type-parameters
branch
from
28ef75d to
76ab811
Compare
2bndy5
requested changes
Jul 20, 2024
jbms
force-pushed
the
feat-python-type-parameters
branch
from
e11db38 to
81b5961
Compare
2bndy5
approved these changes
Jul 21, 2024
Sphinx has partial support for type parameter lists: they are supported by the Python domain in signatures, but are not supported by autodoc. This adds the following support: - Sphinx Python domain for type parameter fields in docstrings, with sphinx.ext.napoleon support as well. - Support for type parameters as Sphinx objects, with cross-linking, like the existing support for function parameters as Sphinx objects. - Support in apigen for PEP 695 type parameters, and for displaying pre-PEP 695 separately-defined TypeVar types as PEP 695 type parameters. Co-authored-by: Brendan <2bndy5@gmail.com>
jbms
force-pushed
the
feat-python-type-parameters
branch
from
81b5961 to
640b5c7
Compare
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.
Sphinx has partial support for type parameter lists: they are supported by the Python domain in signatures, but are not supported by autodoc.
This adds the following support:
Sphinx Python domain for type parameter fields in docstrings, with sphinx.ext.napoleon support as well.
Support for type parameters as Sphinx objects, with cross-linking, like the existing support for function parameters as Sphinx objects.
Support in apigen for PEP 695 type parameters, and for displaying pre-PEP 695 separately-defined TypeVar types as PEP 695 type parameters.