Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork3.1k
stubgenc: add support for including class and property docstrings#17964
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
JelleZijlstra merged 1 commit intopython:masterfromchadrik:stubgen/docstrings-for-c-modulesMay 20, 2025
Merged
stubgenc: add support for including class and property docstrings#17964
JelleZijlstra merged 1 commit intopython:masterfromchadrik:stubgen/docstrings-for-c-modulesMay 20, 2025
Uh oh!
There was an error while loading.Please reload this page.
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 comment has been minimized.
This comment has been minimized.
07cde23 tob229f27Compare This comment has been minimized.
This comment has been minimized.
c6ca0d5 to787d5b6Compare This comment has been minimized.
This comment has been minimized.
787d5b6 to7a0db40CompareContributorAuthor
chadrik commentedFeb 24, 2025
@hamdanal@JelleZijlstra This is ready for review. |
Contributor
According tomypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
ContributorAuthor
chadrik commentedMay 19, 2025
Hi, does anyone have a moment to review this, please! |
JelleZijlstra approved these changesMay 20, 2025
a9bb737 intopython:master 19 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
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