From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 30 Dec 2024 21:14:27 +0000 (+0100)
Subject: [3.12] gh-128342: Specify timeout unit in subprocess docstrings (GH-128343) (#128366)
X-Git-Tag: v3.12.9~128
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fcc9bc49c4f708a800ba0d67a39ca467c649960f;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-128342: Specify timeout unit in subprocess docstrings (GH-128343) (#128366)

gh-128342: Specify timeout unit in subprocess docstrings (GH-128343)

Specify timeout unit (seconds) in subprocess docstrings
(cherry picked from commit dafe7a44630aa32bb411cceb45c7b7df725e3fe3)

Co-authored-by: n-l-i <57808975+n-l-i@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
---

diff --git a/Lib/subprocess.py b/Lib/subprocess.py
index 1d17ae3608a5..881a9ce800ae 100644
--- a/Lib/subprocess.py
+++ b/Lib/subprocess.py
@@ -380,7 +380,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:
 
@@ -517,8 +517,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