Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EoinTrial wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −1
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Doc/library/glob.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ The :mod:`!glob` module defines the following functions:
pattern is followed by an :data:`os.sep` or :data:`os.altsep` then files will not
match.

If *include_hidden* is true, "``**``" pattern will match hidden directories.
If *include_hidden* is true, patterns that do not begin with a dot (``.``)
may also match path components that begin with a dot.

.. audit-event:: glob.glob pathname,recursive glob.glob
.. audit-event:: glob.glob/2 pathname,recursive,root_dir,dir_fd glob.glob
Expand Down
12 changes: 12 additions & 0 deletions Misc/NEWS.d/next/Documentation/2026-04-19-20-31-27.gh-issue-148765.SNB_1A.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Fix inaccurate description of the *include_hidden* parameter in
:func:`glob.glob` and :func:`glob.iglob`. The parameter allows all wildcard
patterns to match path components beginning with a dot, not just ``**``
matching "hidden directories" as previously stated.

#.. section: Tests #.. section: Build #.. section: Windows #.. section:
macOS #.. section: IDLE #.. section: Tools/Demos #.. section: C API

# Write your Misc/NEWS.d entry below. It should be a simple ReST paragraph.
# Don't start with "- Issue #<n>: " or "- gh-issue-<n>: " or that sort of
stuff.
###########################################################################
Loading