Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

stubgenc: add support for including class and property docstrings #17964

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

chadrik
Copy link
Contributor

@chadrik chadrik commented Oct 16, 2024

Prior to this change passing --include-docstrings did 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

Copy link
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants