From: Brian Curtin <brian@python.org>
Date: Sat, 23 Jun 2012 03:48:06 +0000 (-0500)
Subject: Fix #15148. Make the shutil.which docstring more thorough
X-Git-Tag: v3.3.0b1~138
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2193536e79c33654cadf85f4b6d8bbe27b43fd2c;p=thirdparty%2FPython%2Fcpython.git

Fix #15148. Make the shutil.which docstring more thorough
---

diff --git a/Lib/shutil.py b/Lib/shutil.py
index f375a5b22059..82d3f09154b1 100644
--- a/Lib/shutil.py
+++ b/Lib/shutil.py
@@ -973,7 +973,9 @@ def get_terminal_size(fallback=(80, 24)):
 
 def which(cmd, mode=os.F_OK | os.X_OK, path=None):
     """Given a command, mode, and a path string, return the path which
-    conforms to the given mode on the path."""
+    conforms to the given mode on the PATH, or None if there is no such file.
+    `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result of
+    os.environ.get("PATH"), or can be overridden with a custom search path."""
     # Check that a given file can be accessed with the correct mode.
     # Additionally check that `file` is not a directory, as on Windows
     # directories pass the os.access check.