summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-20 21:09:18 (GMT)
committerGitHub <noreply@github.com>2023-08-20 21:09:18 (GMT)
commitf2cc00527efeb69497e4304e826dd3a518005d1a (patch)
treefe0b0d4e657369578ad399f351e84a25dc1efacf
parenta6f15af866c4584b970c72b805a2a4a6f3f63b83 (diff)
downloadcpython-f2cc00527efeb69497e4304e826dd3a518005d1a.zip
cpython-f2cc00527efeb69497e4304e826dd3a518005d1a.tar.gz
cpython-f2cc00527efeb69497e4304e826dd3a518005d1a.tar.bz2
[3.12] Resolve reference warnings in faq/library.rst (GH-108149) (#108182)
Resolve reference warnings in faq/library.rst (GH-108149) (cherry picked from commit 6323bc33ff9f445a947adf4af42b8be7e44c730c) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
-rw-r--r--Doc/faq/library.rst13
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 8 insertions, 6 deletions
diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index b43c750..c699107 100644
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -111,7 +111,7 @@ Is there an equivalent to C's onexit() in Python?
-------------------------------------------------
The :mod:`atexit` module provides a register function that is similar to C's
-:c:func:`onexit`.
+:c:func:`!onexit`.
Why don't my signal handlers work?
@@ -397,7 +397,7 @@ These aren't::
D[x] = D[x] + 1
Operations that replace other objects may invoke those other objects'
-:meth:`__del__` method when their reference count reaches zero, and that can
+:meth:`~object.__del__` method when their reference count reaches zero, and that can
affect things. This is especially true for the mass updates to dictionaries and
lists. When in doubt, use a mutex!
@@ -765,14 +765,17 @@ The :mod:`select` module is commonly used to help with asynchronous I/O on
sockets.
To prevent the TCP connect from blocking, you can set the socket to non-blocking
-mode. Then when you do the :meth:`socket.connect`, you will either connect immediately
+mode. Then when you do the :meth:`~socket.socket.connect`,
+you will either connect immediately
(unlikely) or get an exception that contains the error number as ``.errno``.
``errno.EINPROGRESS`` indicates that the connection is in progress, but hasn't
finished yet. Different OSes will return different values, so you're going to
have to check what's returned on your system.
-You can use the :meth:`socket.connect_ex` method to avoid creating an exception. It will
-just return the errno value. To poll, you can call :meth:`socket.connect_ex` again later
+You can use the :meth:`~socket.socket.connect_ex` method
+to avoid creating an exception.
+It will just return the errno value.
+To poll, you can call :meth:`~socket.socket.connect_ex` again later
-- ``0`` or ``errno.EISCONN`` indicate that you're connected -- or you can pass this
socket to :meth:`select.select` to check if it's writable.
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 5a28274..b1894c4 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -26,7 +26,6 @@ Doc/c-api/unicode.rst
Doc/extending/extending.rst
Doc/extending/newtypes.rst
Doc/faq/gui.rst
-Doc/faq/library.rst
Doc/glossary.rst
Doc/howto/descriptor.rst
Doc/howto/enum.rst