]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-128342: Specify timeout unit in subprocess docstrings (GH-128343)
authorn-l-i <57808975+n-l-i@users.noreply.github.com>
Mon, 30 Dec 2024 20:52:04 +0000 (21:52 +0100)
committerGitHub <noreply@github.com>
Mon, 30 Dec 2024 20:52:04 +0000 (20:52 +0000)
Specify timeout unit (seconds) in subprocess docstrings

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Lib/subprocess.py

index 88f0230b05fbc7424b27056f665dc19f3ff44337..de88eedcf80ff98815f1e9bf2ced3df7b569bd91 100644 (file)
@@ -386,7 +386,7 @@ def _text_encoding():
 
 def call(*popenargs, timeout=None, **kwargs):
     """Run command with arguments.  Wait for command to complete or
-    timeout, then return the returncode attribute.
+    for timeout seconds, then return the returncode attribute.
 
     The arguments are the same as for the Popen constructor.  Example:
 
@@ -523,8 +523,8 @@ def run(*popenargs,
     in the returncode attribute, and output & stderr attributes if those streams
     were captured.
 
-    If timeout is given, and the process takes too long, a TimeoutExpired
-    exception will be raised.
+    If timeout (seconds) is given and the process takes too long,
+     a TimeoutExpired exception will be raised.
 
     There is an optional argument "input", allowing you to
     pass bytes or a string to the subprocess's stdin.  If you use this argument