Repository navigation
Add runtime docstrings to stubs in release wheels - #1274
Open
jonathanberthias wants to merge 3 commits into
Open
jonathanberthias wants to merge 3 commits into
jonathanberthias wants to merge 3 commits into
Conversation
Member
Thank you so much for the disclosure, @jonathanberthias ! I'm assuming you reviewed the changes already, correct? |
Contributor
Author
I ran the build workflow on my fork and it seems to work, but I know very little about |
This branch has not been deployed
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
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.
The bundled type stubs contain no docstrings, so editors using them can miss the documentation available on the compiled extension.
This PR copies existing runtime docstrings into the stubs during release wheel builds using docstring-adder. It runs after native libraries are bundled and repacks the wheel with updated file hashes. This applies to Python 3.10 and later, as required by docstring-adder.
The implementation was generated with AI assistance.
Part of #1072