stubgenc: add support for including class and property docstrings#17964
Merged
JelleZijlstra merged 1 commit intoMay 20, 2025
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
chadrik
force-pushed
the
stubgen/docstrings-for-c-modules
branch
from
07cde23 to
b229f27
Compare
This comment has been minimized.
This comment has been minimized.
chadrik
force-pushed
the
stubgen/docstrings-for-c-modules
branch
2 times, most recently
from
c6ca0d5 to
787d5b6
Compare
This comment has been minimized.
This comment has been minimized.
chadrik
force-pushed
the
stubgen/docstrings-for-c-modules
branch
from
787d5b6 to
7a0db40
Compare
Contributor
Author
|
@hamdanal @JelleZijlstra This is ready for review. |
Contributor
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
Contributor
Author
|
Hi, does anyone have a moment to review this, please! |
JelleZijlstra
approved these changes
May 20, 2025
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
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.
Prior to this change passing
--include-docstringsdid not generate docstrings for classes or properties, only functions. This PR brings c-extensions up to parity with pure-python modules.I used this feature to generate stubs for this project: https://github.com/LumaPictures/cg-stubs/blob/master/usd/stubs/pxr/Usd/__init__.pyi