Skip to content

gh-89770: [PEP-678] documentation on exception notes #30441

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
iritkatriel merged 5 commits into from
Apr 20, 2022
+72 −0
Merged

gh-89770: [PEP-678] documentation on exception notes #30441

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
37a7347
Revert "remove __note__ documentation"
iritkatriel Jan 6, 2022
75bfd31
reword intro
iritkatriel Jan 17, 2022
729c10c
Update for accepted version of the PEP
iritkatriel Apr 18, 2022
192bf86
apply comments from gps
iritkatriel Apr 18, 2022
8bf05ec
Update example output (we added the sub-exception count after this PR…
iritkatriel Apr 19, 2022
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
Prev Previous commit
Next Next commit
apply comments from gps
  • Loading branch information
@iritkatriel
iritkatriel committed Apr 18, 2022
commit 192bf861b738bf56897adee6cf36d7d4e8b273b1
6 changes: 3 additions & 3 deletions Doc/tutorial/errors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,9 +558,9 @@ Enriching Exceptions with Notes
When an exception is created in order to be raised, it is usually initialized
with information that describes the error that has occurred. There are cases
where it is useful to add information after the exception was caught. For this
purpose, exceptions have a method ``add_node(note)`` that accepts a string and
adds it to the exception's notes list. The standard traceback includes all
notes, in the order they were added, after the exception. ::
purpose, exceptions have a method ``add_note(note)`` that accepts a string and
adds it to the exception's notes list. The standard traceback rendering
includes all notes, in the order they were added, after the exception. ::

>>> try:
... raise TypeError('bad type')
Expand Down