Skip to content

Commit c787ab2

Browse files
committed
Improved docstring for processes.which
1 parent 9b557e8 commit c787ab2

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/bd2k/util/processes.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ def which( name, path=None ):
77
or the directories listed in the PATH variable of the current environment. Roughly the
88
equivalent of the `which` program. Does not work on Windows.
99
10-
:param executable_name: the name of the program
10+
:type name: str
11+
:param name: the name of the program
1112
12-
:type executable_name: str
13-
14-
:param path: an iterable of directory paths to consider or None if the PATH environment
15-
variable should be used
13+
:type path: Iterable
14+
:param path: the directory paths to consider or None if the directories referenced in the
15+
PATH environment variable should be used instead
1616
1717
:returns: an iterator yielding the full path to every occurrance of an executable file of the
1818
given name in a directory on the given path or the PATH environment variable if no path was

0 commit comments

Comments
 (0)