[docs] [issue15148] shutil.which() docstring could be clearer

R. David Murray report at bugs.python.org
Sat Jun 23 05:27:47 CEST 2012


R. David Murray <rdmurray at bitdance.com> added the comment:

Yeah, Brian had it as 'file' before, and I asked him to change it because it is confusing.  'file' sounds like a Python file object, which this is not.  'filename' would be OK, but 'cmd', as you note, is what it is really about.

One possibility for the path confusion is to capitalize the references to the system path, since both posix and windows capitalize it.:

"Given a name, mode, and PATH, return the path to the first file which conforms to the given mode found on the PATH, or None if there is no such file.  mode defaults to os.F_OK|os.X_OK.  PATH can be specified via the path argument, if not specified it defaults to the PATH set in the environment."

----------
nosy: +r.david.murray

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15148>
_______________________________________


More information about the docs mailing list