Extend documentation for redefined-builtin
#10167
Merged
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.
Closes #10160
Type of Changes
Description
The
redefined-builtin
check has an option -allowed-redefined-builtins
that allows users to specify names that are allowed to shadow built-ins. However, there are exceptions where this option does not apply, which might lead to confusion. Users may reasonably expect the option to be effective in all cases.The option is not effective when:
global
keyword is applied to the nameThe justification for these exceptions was discussed in #3643. Therefore, these cases should be documented to provide better clarity for users.
Additionally, add functional test for the
global
keyword case, as it is not covered by existing tests.Screenshot reference of updated doc page:
Closes #10160