docs: document that stubtest ignores private stub names#21735
Open
pctablet505 wants to merge 1 commit into
Open
docs: document that stubtest ignores private stub names#21735pctablet505 wants to merge 1 commit into
pctablet505 wants to merge 1 commit into
Conversation
Add a section to the stubtest documentation explaining that names beginning with a leading underscore are treated as private to the stub and will not be flagged if missing at runtime. Fixes python#15414
pctablet505
marked this pull request as ready for review
July 17, 2026 12:47
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
1 participant
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.
Fixes #15414
Adds a section to the stubtest documentation explaining that names beginning with a leading underscore are treated as private to the stub. This documents the existing behaviour used by typeshed, so users know they can use names like "_T" for TypeVars that don't exist at runtime.