mirror of
https://github.com/python/cpython.git
synced 2026-10-28 10:25:05 +08:00
gh-148765: Fix description of *include_hidden* parameter in glob.glob() docs (#148768)
Co-authored-by: Stan Ulbrych <stan@python.org>
This commit is contained in:
1 parent
b1756212f2
commit
db3a4773e1
3 files changed
+9
-7
No files matched your search
@@ -29,7 +29,7 @@ not by actually invoking a subshell.
|
||||
The pathnames are returned in no particular order. If you need a specific
|
||||
order, sort the results.
|
||||
|
||||
Files beginning with a dot (``.``) can only be matched by
|
||||
By default, files beginning with a dot (``.``) can only be matched by
|
||||
patterns that also start with a dot,
|
||||
unlike :func:`fnmatch.fnmatch` or :func:`pathlib.Path.glob`.
|
||||
For tilde and shell variable expansion, use :func:`os.path.expanduser` and
|
||||
@@ -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, wildcards can match path segments 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
|
||||
@@ -131,7 +132,7 @@ The :mod:`!glob` module defines the following functions:
|
||||
Escape all special characters (``'?'``, ``'*'`` and ``'['``).
|
||||
This is useful if you want to match an arbitrary literal string that may
|
||||
have special characters in it. Special characters in drive/UNC
|
||||
sharepoints are not escaped, e.g. on Windows
|
||||
sharepoints are not escaped, for example on Windows
|
||||
``escape('//?/c:/Quo vadis?.txt')`` returns ``'//?/c:/Quo vadis[?].txt'``.
|
||||
|
||||
.. versionadded:: 3.4
|
||||
|
||||
+4
-4
@@ -34,8 +34,8 @@ def glob(pathname, *, root_dir=None, dir_fd=None, recursive=False,
|
||||
If `dir_fd` is not None, it should be a file descriptor referring to a
|
||||
directory, and paths will then be relative to that directory.
|
||||
|
||||
If `include_hidden` is true, the patterns '*', '?', '**' will match
|
||||
hidden directories.
|
||||
If `include_hidden` is true, wildcards can match path segments beginning
|
||||
with a dot ('.').
|
||||
|
||||
If `recursive` is true, the pattern '**' will match any files and
|
||||
zero or more directories and subdirectories.
|
||||
@@ -64,8 +64,8 @@ def iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False,
|
||||
If `dir_fd` is not None, it should be a file descriptor referring to a
|
||||
directory, and paths will then be relative to that directory.
|
||||
|
||||
If `include_hidden` is true, the patterns '*', '?', '**' will match
|
||||
hidden directories.
|
||||
If `include_hidden` is true, wildcards can match path segments beginning
|
||||
with a dot ('.').
|
||||
|
||||
If `recursive` is true, the pattern '**' will match any files and
|
||||
zero or more directories and subdirectories.
|
||||
|
||||
Reference in new issue
Block a user