[Python-checkins] Resolve reference warnings in faq/library.rst (#108149)
hugovk
webhook-mailer at python.org
Sun Aug 20 15:01:16 EDT 2023
https://github.com/python/cpython/commit/6323bc33ff9f445a947adf4af42b8be7e44c730c
commit: 6323bc33ff9f445a947adf4af42b8be7e44c730c
branch: main
author: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
committer: hugovk <hugovk at users.noreply.github.com>
date: 2023-08-20T19:01:13Z
summary:
Resolve reference warnings in faq/library.rst (#108149)
Co-authored-by: Erlend E. Aasland <erlend.aasland at protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk at users.noreply.github.com>
files:
M Doc/faq/library.rst
M Doc/tools/.nitignore
diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index 9e3727456bb96..476a43d9c288f 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!
@@ -730,14 +730,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 0262a0afe4546..9475e883ee5b5 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -25,7 +25,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
More information about the Python-checkins
mailing list