Skip to content

gh-111157: Mention __notes__ in traceback.format_exception_only docstring #111158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 21, 2023
Merged

gh-111157: Mention __notes__ in traceback.format_exception_only docstring #111158

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82f3538
gh-111157: Mention `__notes__` in `traceback.format_exception_only` d…
sobolevn Oct 21, 2023
919d35e
Better wording
sobolevn Oct 21, 2023
9531e49
Wording
sobolevn Oct 21, 2023
cecf02b
typo
iritkatriel Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions Lib/traceback.py
View file
Open in desktop
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