gh-148765: Fix description of include_hidden parameter in glob docs#148768
Open
EoinTrial wants to merge 1 commit intopython:mainfrom
Open
gh-148765: Fix description of include_hidden parameter in glob docs#148768EoinTrial wants to merge 1 commit intopython:mainfrom
include_hidden parameter in glob docs#148768EoinTrial wants to merge 1 commit intopython:mainfrom
Conversation
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
include_hiddenparameter inglob.glob()andglob.iglob()is described as:This is inaccurate because the flag affects all wildcard patterns, not just
**, and "hidden directories" wrongly implies WindowsFILE_ATTRIBUTE_HIDDENrather than dot-prefixed names.The fix aligns the wording with
glob.translate(), which already uses the correct description in the same file.Discourse thread from 2022 where this was identified: https://discuss.python.org/t/new-glob-documentation-could-be-improved/19054
📚 Documentation preview 📚: https://cpython-previews--148768.org.readthedocs.build/