-
-
Notifications
You must be signed in to change notification settings - Fork 945
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.
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
docs(FAQ): add entry for error tracebacks in ASGI apps #2395
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2395 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7726 7726
Branches 1071 1071
=========================================
Hits 7726 7726 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @chitvs, and thank you very much for this improvement!
Unfortunately, I don't have time for a full review right now, cause I'm on vacation in your beautiful country (mostly in Liguria FWIW).
Your changes look good at first glance except
- You shouldn't render out the newsfragments yourself, we only do that ourselves when releasing a new version of the framework. Could you undo this part?
- I would prefer to link from the FAQ to the tutorial, not the other way around.
Btw I don't know if you are participating in Hacktoberfest, but this is already good enough to qualify, I'll add the label just in case. |
Sure, I will change that. (btw I'm from Italy so have a nice weekend there!) |
Yes I'm participating, thanks! |
…GI error logging" This reverts commit 3225562.
I did all the changes requested, when you have time take a look but imo now should be good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this LGTM bar a couple of very minor nitpicks that I can address in another PR.
Summary of Changes
Added a new FAQ entry explaining why error tracebacks do not appear in ASGI applications by default when using Falcon. Updated the tutorial on ASGI applications to include instructions on configuring logging to capture error tracebacks.
Related Issues
Closes #2393
Pull Request Checklist
(Note: Confirm that the changes are relevant to both interfaces.)
(Note: Ensure that you have written tests for any new functionality introduced.)
(Note: Ensure all comments are correctly prefixed.)
(Note: Run
ruff format
to ensure compliance.)docs/
.docs/
.versionadded
,versionchanged
, ordeprecated
directives.(Note: Add these directives where necessary.)
docs/_newsfragments/
, with the file name format{issue_number}.{fragment_type}.rst
.(Note: Make sure to create a news fragment if your changes are substantial.)