Skip to content

Commit

Permalink
gh-111157: Mention __notes__ in traceback.format_exception_only d…
Browse files Browse the repository at this point in the history
…ocstring (#111158)
  • Loading branch information
sobolevn committed Oct 21, 2023
1 parent 9a1fe09 commit 5e7727b
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions Lib/traceback.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,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
Expand Down Expand Up @@ -857,13 +854,13 @@ def format_exception_only(self, *, show_group=False, _depth=0):
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__``.
"""

indent = 3 * _depth * ' '
Expand Down

0 comments on commit 5e7727b

Please sign in to comment.