Skip to content

Commit 8aa4a5b

Browse files
committed
docs(run): Update docstring
1 parent 709599a commit 8aa4a5b

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

libvcs/_internal/run.py

+6-5
Original file line numberDiff line numberDiff line change
@@ -199,20 +199,21 @@ def run(
199199
check_returncode: bool = True,
200200
callback: Optional[ProgressCallbackProtocol] = None,
201201
):
202-
"""Run 'cmd' in a shell and return the combined contents of stdout and
203-
stderr (Blocking). Throws an exception if the command exits non-zero.
202+
"""Run 'args' in a shell and return the combined contents of stdout and
203+
stderr (Blocking). Throws an exception if the command exits non-zero.
204+
205+
Keyword arguments are passthrough to {class}`subprocess.Popen`.
204206
205207
Parameters
206208
----------
207-
cmd : list or str, or single str, if shell=True
209+
args : list or str, or single str, if shell=True
208210
the command to run
209211
210212
shell : boolean
211213
boolean indicating whether we are using advanced shell
212214
features. Use only when absolutely necessary, since this allows a lot
213215
more freedom which could be exploited by malicious code. See the
214-
warning here:
215-
http://docs.python.org/library/subprocess.html#popen-constructor
216+
warning here: http://docs.python.org/library/subprocess.html#popen-constructor
216217
217218
cwd : str
218219
dir command is run from. Defaults to ``path``.

0 commit comments

Comments
 (0)