gh-138722: rephrased sys.excephook section about auditing events #138723
Conversation
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
Co-authored-by: MeGaGiGaGon <[email protected]>
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
awaiting review
docs
|
For more context, while helping Mortiz in the Python discord, we both got stumped by this section of the docs. The issue with the existing phrasing is that there are two hook types - exception hooks and audit hooks. Since the last paragraph is not clear about which hook gets suppressed, we originally though it meant that the exception hook gets suppressed. This PR makes it clear that only the audit hooks have this special behavior around |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changed the phrasing of the section of sys.excepthook docs to be clearer.
This phrasing seems less prone to misunderstanding IMO.
📚 Documentation preview 📚: https://cpython-previews--138723.org.readthedocs.build/