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.

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

Merged
merged 6 commits into from
Nov 5, 2024

Conversation

chitvs
Copy link
Contributor

@chitvs chitvs commented Oct 30, 2024

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

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
    (Note: Confirm that the changes are relevant to both interfaces.)
  • Added tests for changed code.
    (Note: Ensure that you have written tests for any new functionality introduced.)
  • Prefixed code comments with GitHub nick and an appropriate prefix.
    (Note: Ensure all comments are correctly prefixed.)
  • Coding style is consistent with the rest of the framework.
    (Note: Run ruff format to ensure compliance.)
  • Updated documentation for changed code.
    • Added docstrings for any new classes, functions, or modules.
    • Updated docstrings for any modifications to existing code.
    • Updated both WSGI and ASGI docs (where applicable).
    • Added references to new classes, functions, or modules to the relevant RST file under docs/.
    • Updated all relevant supporting documentation files under docs/.
    • A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      (Note: Add these directives where necessary.)
  • Changes (and possible deprecations) have towncrier news fragments under 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.)

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ca2e6d9) to head (8029c68).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

Copy link
Member

@vytas7 vytas7 left a 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.

@vytas7
Copy link
Member

vytas7 commented Oct 31, 2024

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.

@chitvs
Copy link
Contributor Author

chitvs commented Oct 31, 2024

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.

Sure, I will change that. (btw I'm from Italy so have a nice weekend there!)

@chitvs
Copy link
Contributor Author

chitvs commented Oct 31, 2024

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.

Yes I'm participating, thanks!

@chitvs
Copy link
Contributor Author

chitvs commented Oct 31, 2024

I did all the changes requested, when you have time take a look but imo now should be good.

@vytas7 vytas7 changed the title Add FAQ entry for error tracebacks in ASGI applications and update tutorial for logging docs(FAQ): add entry for error tracebacks in ASGI apps Oct 31, 2024
@vytas7 vytas7 requested a review from CaselIT October 31, 2024 17:12
Copy link
Member

@vytas7 vytas7 left a 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.

@vytas7 vytas7 merged commit ab2ce4c into falconry:master Nov 5, 2024
31 checks passed
@chitvs chitvs deleted the improve-asgi-error-docs branch November 5, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve docs regarding error reporting under asgi; add FAQ item
3 participants