[Python-checkins] Fix broken link in `asyncio-subprocesses` doc (GH-99214)

miss-islington webhook-mailer at python.org
Tue Nov 8 11:33:57 EST 2022


https://github.com/python/cpython/commit/ca944628acd83243f1511d118d39091dae82224f
commit: ca944628acd83243f1511d118d39091dae82224f
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-11-08T08:33:51-08:00
summary:

Fix broken link in `asyncio-subprocesses` doc (GH-99214)


GH- 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.htmlGH-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)
(cherry picked from commit acf4d5d5bdecbc8756276731e09bae245d88518d)

Co-authored-by: Mikael Koli <koli.mikael at gmail.com>
Automerge-Triggered-By: GH:AlexWaygood

files:
M Doc/library/asyncio-subprocess.rst

diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst
index 28d0b21e8180..4274638c5e86 100644
--- a/Doc/library/asyncio-subprocess.rst
+++ b/Doc/library/asyncio-subprocess.rst
@@ -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



More information about the Python-checkins mailing list