gh-99350: Fix symtable.SymbolTable.is_nested() documentation#151901
Open
iamsharduld wants to merge 1 commit into
Open
gh-99350: Fix symtable.SymbolTable.is_nested() documentation#151901iamsharduld wants to merge 1 commit into
iamsharduld wants to merge 1 commit into
Conversation
The docstring and library reference described is_nested() as returning True for 'a nested class or function', which wrongly implies any nesting. The underlying flag is only set when the block is nested within a function, so a method of a top-level class is not nested. Reword both descriptions and add a characterizing assertion to test_nested.
Documentation build overview
|
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.
The docstring and library reference described
is_nested()as returningTruefor "a nested class or function", which wrongly implies any nesting. The
underlying flag is only set when the block is nested (directly or indirectly)
within a function, so for example a method of a top-level class returns
False.Reword both descriptions and add a characterizing assertion to
test_nested(a method of a top-level class is not nested).