FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-148765: Fix description of `include_hidden` parameter in glob docs by EoinTrial · Pull Request #148768 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-148765: Fix description of include_hidden parameter in glob docs - #148768

Merged
StanFromIreland merged 9 commits into
python:mainfrom
EoinTrial:fix/glob-include-hidden-docs
Jul 6, 2026
ConversationCommits (9)ChecksFiles changed
Merged

gh-148765: Fix description of include_hidden parameter in glob docs#148768
StanFromIreland merged 9 commits into
python:mainfrom
EoinTrial:fix/glob-include-hidden-docs

Conversation

EoinTrial commented Apr 19, 2026 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

The include_hidden parameter in glob.glob() and glob.iglob() is described as:

If include_hidden is true, "**" pattern will match hidden directories.

This is inaccurate because the flag affects all wildcard patterns, not just **, and "hidden directories" wrongly implies Windows FILE_ATTRIBUTE_HIDDEN rather 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/

bedevere-app Bot added awaiting review docs Documentation in the Doc dir labels Apr 19, 2026
github-project-automation Bot moved this to Todo in Docs PRs Apr 19, 2026
bedevere-app Bot mentioned this pull request Apr 19, 2026
Closed
EoinTrial force-pushed the fix/glob-include-hidden-docs branch from 61d30bc to 6182c5d Compare April 30, 2026 20:19

This comment was marked as low quality.

Sign in to view

read-the-docs-community Bot commented Apr 30, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33450291 | 📁 Comparing 77ebe42 against main (a8c9aa9)

  🔍 Preview build  

254 files changed · + 6 added · ± 247 modified · - 1 deleted

+ Added

± Modified

- Deleted

StanFromIreland reviewed Jul 5, 2026
View reviewed changes
Comment thread Doc/library/glob.rst Outdated

This comment was marked as spam.

Sign in to view

StanFromIreland commented Jul 5, 2026

Copy link
Copy Markdown
Member

There are conflicts now.

EoinTrial requested a review from StanFromIreland July 5, 2026 17:57
StanFromIreland reviewed Jul 5, 2026
View reviewed changes
Comment thread Doc/library/glob.rst Outdated
Comment thread Doc/library/glob.rst Outdated
Comment thread Doc/library/glob.rst Outdated
EoinTrial requested a review from StanFromIreland July 5, 2026 18:24
StanFromIreland approved these changes Jul 5, 2026
View reviewed changes

StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, please just tidy up the blurb.

Comment thread Misc/NEWS.d/next/Documentation/2026-07-05-19-00-00.gh-issue-148765.fixglob1.rst Outdated

This comment was marked as resolved.

Sign in to view

This comment was marked as abuse.

Sign in to view

EoinTrial commented Jul 5, 2026

Copy link
Copy Markdown
Contributor Author

@StanFromIreland Thanks for all of your help! Good to merge? :)

StanFromIreland merged commit db3a477 into python:main Jul 6, 2026
97 of 99 checks passed
github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 6, 2026
StanFromIreland added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Jul 6, 2026

miss-islington-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

Thanks @EoinTrial for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

Thanks @EoinTrial for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

Thanks @EoinTrial for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

bedevere-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

GH-153172 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jul 6, 2026

bedevere-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

GH-153173 is a backport of this pull request to the 3.15 branch.

bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Jul 6, 2026

bedevere-app Bot commented Jul 6, 2026

Copy link
Copy Markdown

GH-153174 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 6, 2026

StanFromIreland commented Jul 6, 2026

Copy link
Copy Markdown
Member

Merged, thanks.

StanFromIreland added a commit that referenced this pull request Jul 6, 2026
[3.14] gh-148765: Fix description of *include_hidden* parameter in `g…
51033f9 
…lob.glob()` docs (GH-148768) (#153174)

(cherry picked from commit db3a477)

Co-authored-by: Eoin Shaughnessy <45000144+EoinTrial@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
StanFromIreland added a commit that referenced this pull request Jul 6, 2026
[3.13] gh-148765: Fix description of *include_hidden* parameter in `g…
8e060bb 
…lob.glob()` docs (GH-148768) (#153172)

(cherry picked from commit db3a477)

Co-authored-by: Eoin Shaughnessy <45000144+EoinTrial@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
StanFromIreland added a commit that referenced this pull request Jul 6, 2026
[3.15] gh-148765: Fix description of *include_hidden* parameter in `g…
8e7c2ca 
…lob.glob()` docs (GH-148768) (#153173)

(cherry picked from commit db3a477)

Co-authored-by: Eoin Shaughnessy <45000144+EoinTrial@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
coderabbitai Bot mentioned this pull request Jul 31, 2026
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

StanFromIreland StanFromIreland approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL