summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFilipe LaĆ­ns <lains@riseup.net>2024-05-01 23:13:32 (GMT)
committerGitHub <noreply@github.com>2024-05-01 23:13:32 (GMT)
commit97feb4a78bf1ebdec26b685fd509cf57b3333e4a (patch)
treef9d2594a38fa65515b5be9f55b56d4843e07f6e2
parentc408c36e9b346f9f15a34e98a5596f311df65efa (diff)
downloadcpython-97feb4a78bf1ebdec26b685fd509cf57b3333e4a.zip
cpython-97feb4a78bf1ebdec26b685fd509cf57b3333e4a.tar.gz
cpython-97feb4a78bf1ebdec26b685fd509cf57b3333e4a.tar.bz2
GH-118174: specify the type for the path argument of shutil.which
-rw-r--r--Doc/library/shutil.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 8e5828c..542d288 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -449,8 +449,9 @@ Directory and files operations
*mode* is a permission mask passed to :func:`os.access`, by default
determining if the file exists and executable.
- When no *path* is specified, the results of :func:`os.environ` are used,
- returning either the "PATH" value or a fallback of :data:`os.defpath`.
+ *path* is a "``PATH`` string" specifying the lookup directory list. When no
+ *path* is specified, the results of :func:`os.environ` are used, returning
+ either the "PATH" value or a fallback of :data:`os.defpath`.
On Windows, the current directory is prepended to the *path* if *mode* does
not include ``os.X_OK``. When the *mode* does include ``os.X_OK``, the