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

EoinTrial · 2026-04-19T19:41:05Z

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

Issue: glob.glob() docs incorrectly describe include_hidden as only affecting ** pattern #148765

📚 Documentation preview 📚: https://cpython-previews--148768.org.readthedocs.build/

…docs

read-the-docs-community · 2026-04-30T20:25:28Z

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

library/asyncio-policy.html

StanFromIreland · 2026-07-05T17:46:14Z

There are conflicts now.

…en-docs # Conflicts: # Lib/glob.py

Co-authored-by: Stan Ulbrych <stan@python.org>

… fix/glob-include-hidden-docs

StanFromIreland

LGTM, please just tidy up the blurb.

EoinTrial · 2026-07-05T22:40:13Z

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

miss-islington-app · 2026-07-06T07:45:25Z

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

miss-islington-app · 2026-07-06T07:45:25Z

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

miss-islington-app · 2026-07-06T07:45:25Z

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 · 2026-07-06T07:45:37Z

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

bedevere-app · 2026-07-06T07:45:44Z

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

bedevere-app · 2026-07-06T07:45:49Z

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

StanFromIreland · 2026-07-06T07:48:47Z

Merged, thanks.

…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>

…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>

…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>

bedevere-app Bot added awaiting review docs Documentation in the Doc dir labels Apr 19, 2026

github-project-automation Bot added this to Docs PRs 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

glob.glob() docs incorrectly describe include_hidden as only affecting ** pattern #148765

Closed

StanFromIreland reviewed Apr 30, 2026

View reviewed changes

Comment thread Misc/NEWS.d/next/Documentation/2026-04-19-20-31-27.gh-issue-148765.SNB_1A.rst Outdated

pythongh-148765: Fix description of include_hidden parameter in glob …

6182c5d

…docs

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

EoinTrial requested a review from StanFromIreland April 30, 2026 20:20

StanFromIreland reviewed Jul 5, 2026

View reviewed changes

Comment thread Doc/library/glob.rst Outdated

Clarify include_hidden wording per review feedback

e13d571

This comment was marked as spam.

Sign in to view

StanFromIreland added the skip issue label Jul 5, 2026

EoinTrial added 2 commits July 5, 2026 18:53

Merge remote-tracking branch 'origin/main' into fix/glob-include-hidd…

6ad6c0b

…en-docs # Conflicts: # Lib/glob.py

Add NEWS entry for include_hidden docs fix

9f5d4fe

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 and others added 3 commits July 5, 2026 19:17

Update Doc/library/glob.rst

94089bf

Co-authored-by: Stan Ulbrych <stan@python.org>

Address review feedback: reword dot-file note and e.g. -> for example

05b70cc

Merge remote-tracking branch 'fork/fix/glob-include-hidden-docs' into…

2224f5b

… fix/glob-include-hidden-docs

EoinTrial requested a review from StanFromIreland July 5, 2026 18:24

StanFromIreland approved these changes Jul 5, 2026

View reviewed changes

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

bedevere-app Bot added awaiting merge and removed awaiting review labels Jul 5, 2026

Remove NEWS entry per review, add self to Misc/ACKS

8ad74a1

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into fix/glob-include-hidden-docs

77ebe42

This comment was marked as abuse.

Sign in to view

StanFromIreland added skip news and removed skip issue labels Jul 5, 2026

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

bedevere-app Bot removed the awaiting merge label Jul 6, 2026

StanFromIreland added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jul 6, 2026

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

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

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

Uh oh!

Uh oh!

Conversation

EoinTrial commented Apr 19, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as low quality.

read-the-docs-community Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Uh oh!

This comment was marked as spam.

StanFromIreland commented Jul 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as abuse.

EoinTrial commented Jul 5, 2026

Uh oh!

Uh oh!

miss-islington-app Bot commented Jul 6, 2026

Uh oh!

miss-islington-app Bot commented Jul 6, 2026

Uh oh!

miss-islington-app Bot commented Jul 6, 2026

Uh oh!

bedevere-app Bot commented Jul 6, 2026

Uh oh!

bedevere-app Bot commented Jul 6, 2026

Uh oh!

bedevere-app Bot commented Jul 6, 2026

Uh oh!

StanFromIreland commented Jul 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

EoinTrial commented Apr 19, 2026 •

edited by github-actions Bot

Loading

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

edited

Loading