Skip to content
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

Jump to bottom

Revise exception handling doc on error handler functions #2021

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Revise exception handling doc on error handler functions #2021

wants to merge 2 commits into from

Conversation

chrisinmtown
Copy link
Contributor

@chrisinmtown chrisinmtown commented Dec 17, 2024 •
edited
Loading

Document that a sync function is run in a threadpool and has no access
to the exception stack traceback, but an async function does.
Extend the add_error_handler function's Pydoc similarly

Fixes #2019

@chrisinmtown
Copy link
Contributor Author

Please consider this first draft of my proposed doc improvement to guide people in the use of exception handlers.

@coveralls
Copy link

coveralls commented Dec 17, 2024 •
edited
Loading

Coverage Status

coverage: 94.419%. remained the same
when pulling 89b902b on chrisinmtown:2019-async-exc-handler
into 1844a2f on spec-first:main.

@chrisinmtown chrisinmtown force-pushed the 2019-async-exc-handler branch from 85de9ab to 45406de Compare December 18, 2024 10:25
@chrisinmtown chrisinmtown mentioned this pull request Dec 22, 2024
Open
@chrisinmtown chrisinmtown force-pushed the 2019-async-exc-handler branch from 45406de to c74d411 Compare December 23, 2024 21:34
@chrisinmtown chrisinmtown changed the title Revise exceptions doc to use async coroutine handler functions Revise exception handling doc on error handler functions Dec 23, 2024
@chrisinmtown chrisinmtown force-pushed the 2019-async-exc-handler branch from c74d411 to 4f80dd1 Compare December 23, 2024 21:38
@chrisinmtown
Revise exception handling doc on error handler functions
89b902b 
Document that a sync function is run in a threadpool and has no access
to the exception stack traceback, but an async function does.
Extend the `add_error_handler` function's Pydoc similarly

Fixes spec-first#2019
@chrisinmtown chrisinmtown force-pushed the 2019-async-exc-handler branch from 4f80dd1 to 89b902b Compare December 27, 2024 16:09
@chrisinmtown
Copy link
Contributor Author

Ok I rebased this PR on the latest commit. Would someone please review this tiny documentation change? Just trying to save the next person a little time.

@chrisinmtown
Copy link
Contributor Author

Would someone please decipher this failed check output:

  /home/runner/.cache/pre-commit/repobghb8bkc/py_env-python3.11/lib/python3.11/site-packages/referencing/_core.py:565: error: Invalid "type: ignore" comment
  /home/runner/.cache/pre-commit/repobghb8bkc/py_env-python3.11/lib/python3.11/site-packages/referencing/_core.py:566: error: Invalid "type: ignore" comment
  Found 2 errors in 1 file (errors prevented further checking)

Is mypy complaining about something in this Pydoc change, or is something wrong in the pipeline?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Stack trace not available to logger in v3 error handler function
2 participants
@chrisinmtown @coveralls