gh-150663: Document that PyErr_SetRaisedException accepts null#153046
Open
hrimov wants to merge 2 commits into
Open
gh-150663: Document that PyErr_SetRaisedException accepts null#153046hrimov wants to merge 2 commits into
hrimov wants to merge 2 commits into
Conversation
Documentation build overview
|
| .. note:: | ||
|
|
||
| This call ":term:`steals <steal>`" a reference to *exc*, | ||
| which must be a valid exception. |
Member
There was a problem hiding this comment.
I think this line is helpful. We should just say "must be a valid exception or NULL".
vstinner
reviewed
Jul 7, 2026
| Set *exc* as the exception currently being raised, | ||
| clearing the existing exception if one is set. | ||
| clearing the existing exception if one is set. If *exc* is ``NULL``, | ||
| just clear the existing exception. |
Member
There was a problem hiding this comment.
I suggest adding a new paragraph:
*exc must be a valid exception or ``NULL``.
| just clear the existing exception. | ||
|
|
||
| .. warning:: | ||
| .. note:: |
Member
There was a problem hiding this comment.
I don't think that it deserves to be documented as a note. Other PyErr functions also steal a reference, and they don't use a note or warning, but just write it in the documentation body.
| Set *exc* as the exception currently being raised, | ||
| clearing the existing exception if one is set. | ||
| clearing the existing exception if one is set. If *exc* is ``NULL``, | ||
| just clear the existing exception. |
Member
There was a problem hiding this comment.
Suggested change
| just clear the existing exception. | |
| just clear the existing exception. | |
| This call ":term:`steals <steal>`" a reference to *exc*. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PyErr_SetRaisedException()accepts NULL #150663