]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Fix broken link in `asyncio-subprocesses` doc (GH-99214)
authorMikael Koli <koli.mikael@gmail.com>
Tue, 8 Nov 2022 16:26:06 +0000 (18:26 +0200)
committerGitHub <noreply@github.com>
Tue, 8 Nov 2022 16:26:06 +0000 (08:26 -0800)
# Fix broken link in Doc/library/asyncio-subprocess.rst

This is a trivial fix in documentation to fix a broken link.

There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process) for the function ``wait_for``:

![image](https://user-images.githubusercontent.com/37690409/200388894-fb6b7c42-b2cc-49ec-a239-e3472890db1f.png)

I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs.

This PR fixes the link and the result looks like the following:

![image](https://user-images.githubusercontent.com/37690409/200389483-b4a92105-7d2c-4285-b0fc-78a6dc0be39c.png)

Automerge-Triggered-By: GH:AlexWaygood
Doc/library/asyncio-subprocess.rst

index 28d0b21e8180b64d022c7add1e76a6c611fbc158..4274638c5e86255445573c36e9cf52039d45fae2 100644 (file)
@@ -175,7 +175,7 @@ their completion.
 
    * the :meth:`~asyncio.subprocess.Process.communicate` and
      :meth:`~asyncio.subprocess.Process.wait` methods don't have a
-     *timeout* parameter: use the :func:`wait_for` function;
+     *timeout* parameter: use the :func:`~asyncio.wait_for` function;
 
    * the :meth:`Process.wait() <asyncio.subprocess.Process.wait>` method
      is asynchronous, whereas :meth:`subprocess.Popen.wait` method