]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101100: Fix sphinx warnings in `Doc/library/exceptions.rst` (#136309)
authorYuki Kobayashi <drsuaimqjgar@gmail.com>
Tue, 8 Jul 2025 12:05:05 +0000 (21:05 +0900)
committerGitHub <noreply@github.com>
Tue, 8 Jul 2025 12:05:05 +0000 (15:05 +0300)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Doc/library/exceptions.rst
Doc/tools/.nitignore

index c09e1615a5b733538e5487a826af9dac75ff397e..a73cc2e8a2dd3e55a5d78272e1ea789e9de30592 100644 (file)
@@ -204,10 +204,16 @@ The following exceptions are the exceptions that are usually raised.
    assignment fails.  (When an object does not support attribute references or
    attribute assignments at all, :exc:`TypeError` is raised.)
 
-   The :attr:`name` and :attr:`obj` attributes can be set using keyword-only
-   arguments to the constructor. When set they represent the name of the attribute
-   that was attempted to be accessed and the object that was accessed for said
-   attribute, respectively.
+   The optional *name* and *obj* keyword-only arguments
+   set the corresponding attributes:
+
+   .. attribute:: name
+
+      The name of the attribute that was attempted to be accessed.
+
+   .. attribute:: obj
+
+      The object that was accessed for the named attribute.
 
    .. versionchanged:: 3.10
       Added the :attr:`name` and :attr:`obj` attributes.
@@ -215,7 +221,7 @@ The following exceptions are the exceptions that are usually raised.
 .. exception:: EOFError
 
    Raised when the :func:`input` function hits an end-of-file condition (EOF)
-   without reading any data. (N.B.: the :meth:`io.IOBase.read` and
+   without reading any data. (Note: the :meth:`!io.IOBase.read` and
    :meth:`io.IOBase.readline` methods return an empty string when they hit EOF.)
 
 
@@ -312,9 +318,11 @@ The following exceptions are the exceptions that are usually raised.
    unqualified names.  The associated value is an error message that includes the
    name that could not be found.
 
-   The :attr:`name` attribute can be set using a keyword-only argument to the
-   constructor. When set it represent the name of the variable that was attempted
-   to be accessed.
+   The optional *name* keyword-only argument sets the attribute:
+
+   .. attribute:: name
+
+      The name of the variable that was attempted to be accessed.
 
    .. versionchanged:: 3.10
       Added the :attr:`name` attribute.
@@ -382,7 +390,7 @@ The following exceptions are the exceptions that are usually raised.
 
       The corresponding error message, as provided by
       the operating system.  It is formatted by the C
-      functions :c:func:`perror` under POSIX, and :c:func:`FormatMessage`
+      functions :c:func:`!perror` under POSIX, and :c:func:`!FormatMessage`
       under Windows.
 
    .. attribute:: filename
@@ -398,7 +406,7 @@ The following exceptions are the exceptions that are usually raised.
    .. versionchanged:: 3.3
       :exc:`EnvironmentError`, :exc:`IOError`, :exc:`WindowsError`,
       :exc:`socket.error`, :exc:`select.error` and
-      :exc:`mmap.error` have been merged into :exc:`OSError`, and the
+      :exc:`!mmap.error` have been merged into :exc:`OSError`, and the
       constructor may return a subclass.
 
    .. versionchanged:: 3.4
@@ -597,7 +605,7 @@ The following exceptions are the exceptions that are usually raised.
    handled, the Python interpreter exits; no stack traceback is printed.  The
    constructor accepts the same optional argument passed to :func:`sys.exit`.
    If the value is an integer, it specifies the system exit status (passed to
-   C's :c:func:`exit` function); if it is ``None``, the exit status is zero; if
+   C's :c:func:`!exit` function); if it is ``None``, the exit status is zero; if
    it has another type (such as a string), the object's value is printed and
    the exit status is one.
 
index e29775b075a82fe3c6766a7a9244968181cffe53..4f5396857f3024e52a745702c4165b9a11f1c36b 100644 (file)
@@ -16,7 +16,6 @@ Doc/library/ast.rst
 Doc/library/asyncio-extending.rst
 Doc/library/email.charset.rst
 Doc/library/email.parser.rst
-Doc/library/exceptions.rst
 Doc/library/functools.rst
 Doc/library/http.cookiejar.rst
 Doc/library/http.server.rst