From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 21 Oct 2023 17:07:09 +0000 (+0200)
Subject: [3.12] gh-111157: Mention `__notes__` in `traceback.format_exception_only` docstring... 
X-Git-Tag: v3.12.1~249
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6a5ff9365413fcb7361d5f9edc02f8cfaa0baea9;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-111157: Mention `__notes__` in `traceback.format_exception_only` docstring (GH-111158) (#111163)

gh-111157: Mention `__notes__` in `traceback.format_exception_only` docstring (GH-111158)
(cherry picked from commit 5e7727b05232b43589d177c15263d7f4f8c584a0)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
---

diff --git a/Lib/traceback.py b/Lib/traceback.py
index 813e13e1e0cc..c1be65982cc5 100644
--- a/Lib/traceback.py
+++ b/Lib/traceback.py
@@ -145,14 +145,11 @@ def format_exception_only(exc, /, value=_sentinel):
 
     The return value is a list of strings, each ending in a newline.
 
-    Normally, the list contains a single string; however, for
-    SyntaxError exceptions, it contains several lines that (when
-    printed) display detailed information about where the syntax
-    error occurred.
-
-    The message indicating which exception occurred is always the last
-    string in the list.
-
+    The list contains the exception's message, which is
+    normally a single string; however, for :exc:`SyntaxError` exceptions, it
+    contains several lines that (when printed) display detailed information
+    about where the syntax error occurred. Following the message, the list
+    contains the exception's ``__notes__``.
     """
     if value is _sentinel:
         value = exc
@@ -841,13 +838,13 @@ class TracebackException:
 
         The return value is a generator of strings, each ending in a newline.
 
-        Normally, the generator emits a single string; however, for
-        SyntaxError exceptions, it emits several lines that (when
-        printed) display detailed information about where the syntax
-        error occurred.
-
-        The message indicating which exception occurred is always the last
-        string in the output.
+        Generator yields the exception message.
+        For :exc:`SyntaxError` exceptions, it
+        also yields (before the exception message)
+        several lines that (when printed)
+        display detailed information about where the syntax error occurred.
+        Following the message, generator also yields
+        all the exception's ``__notes__``.
         """
         if self.exc_type is None:
             yield _format_final_exc_line(None, self._str)