Reword docs for exception_handler in CallbackRegistry. #19041
Merged
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
dopplershift
approved these changes
Nov 30, 2020
QuLogic
reviewed
Dec 1, 2020
- Describe the signature of `exception_handler` in prose (the parameter name is not actually relevant, nor is the return value). - "Consuming" an exception is not a standard idiom. - Picklability is a detail here only relevant if you want to pickle the CallbackRegistry, and anyways it is generally true that setting an unpicklable attribute on an otherwise picklable object will make that object unpicklable. - The description of the default exception handler was incorrect.
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.
exception_handlerin prose (the parametername is not actually relevant, nor is the return value).
CallbackRegistry, and anyways it is generally true that setting an
unpicklable attribute on an otherwise picklable object will make that
object unpicklable.
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).