Various improvements

python · willingc · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023
commit 7bd05a57de51c0d45f82d885a05f8980ca8662cc
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
@@ -754,8 +754,8 @@ Exception Objects
 .. c:function:: PyObject* PyException_GetTraceback(PyObject *ex)
 
    Return the traceback associated with the exception as a new reference, as
-   accessible from Python through :attr:`~BaseException.__traceback__`.
-   If there is no
+   accessible from Python through the :attr:`~BaseException.__traceback__`
+   attribute. If there is no
    traceback associated, this returns ``NULL``.
 
 
@@ -769,8 +769,8 @@ Exception Objects
 
    Return the context (another exception instance during whose handling *ex* was
    raised) associated with the exception as a new reference, as accessible from
-   Python through :attr:`~BaseException.__context__`.  If there is no context
-   associated, this returns ``NULL``.
+   Python through the :attr:`~BaseException.__context__` attribute.
+   If there is no context associated, this returns ``NULL``.
 
 
 .. c:function:: void PyException_SetContext(PyObject *ex, PyObject *ctx)
@@ -784,8 +784,8 @@ Exception Objects
 
    Return the cause (either an exception instance, or ``None``,
    set by ``raise ... from ...``) associated with the exception as a new
-   reference, as accessible from Python through
-   :attr:`~BaseException.__cause__`.
+   reference, as accessible from Python through the
+   :attr:`~BaseException.__cause__` attribute.
 
 
 .. c:function:: void PyException_SetCause(PyObject *ex, PyObject *cause)
@@ -794,8 +794,8 @@ Exception Objects
    it.  There is no type check to make sure that *cause* is either an exception
    instance or ``None``.  This steals a reference to *cause*.
 
-   :attr:`~BaseException.__suppress_context__` is implicitly set to ``True`` by
-   this function.
+   The :attr:`~BaseException.__suppress_context__` attribute is implicitly set
+   to ``True`` by this function.
 
 
 .. c:function:: PyObject* PyException_GetArgs(PyObject *ex)

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
@@ -43,13 +43,16 @@ Exception context
            __context__ (exception attribute)
            __suppress_context__ (exception attribute)
 
+Three attributes on exception objects provide information about the context in
+which an the exception was raised:
+
 .. attribute:: BaseException.__context__
                BaseException.__cause__
                BaseException.__suppress_context__
 
    When raising a new exception while another exception
    is already being handled, the new exception's
-   :attr:`__context__` attribute is automatically set to the handled
+   :attr:`!__context__` attribute is automatically set to the handled
    exception.  An exception may be handled when an :keyword:`except` or
    :keyword:`finally` clause, or a :keyword:`with` statement, is used.
 
@@ -139,7 +142,7 @@ The following exceptions are used mostly as base classes for other exceptions.
 
       A writable field that holds the
       :ref:`traceback object <traceback-objects>` associated with this
-      exception. See also :ref:`raise`.
+      exception. See also: :ref:`raise`.
 
    .. method:: add_note(note)
 

diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
@@ -236,8 +236,8 @@ capture data for later printing in a lightweight fashion.
    *capture_locals* are as for the :class:`StackSummary` class.
 
    If *compact* is true, only data that is required by
-   :class:`!TracebackException`'s
-   ``format`` method is saved in the class attributes. In particular, the
+   :class:`!TracebackException`'s :meth:`format` method
+   is saved in the class attributes. In particular, the
    :attr:`__context__` field is calculated only if :attr:`__cause__` is
    ``None`` and :attr:`__suppress_context__` is false.