Skip to content

docs: add a recipe for custom error handling - #2701

Draft
Slavaqq wants to merge 3 commits into
falconry:masterfrom
Slavaqq:recipe-custom-error-handling
Draft

docs: add a recipe for custom error handling#2701
Slavaqq wants to merge 3 commits into
falconry:masterfrom
Slavaqq:recipe-custom-error-handling

Conversation

@Slavaqq

@Slavaqq Slavaqq commented Jul 22, 2026

Copy link
Copy Markdown

Summary of Changes

This PR adds a recipe for handling a custom error. It was created during EuroPython 2026 sprints, and it is draft.

What needs to be improve:

  • write tests for the recipe
  • enrich the description in the documentation

Please let me know if this is a good start and what else I need to improved.
I would like to continue with this issue if it is possible.

Related Issues

#2692

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. Reading our contribution guide at least once will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
  • Added tests for changed code.
  • Performed automated tests and code quality checks by running tox.
  • Prefixed code comments with GitHub nick and an appropriate prefix.
  • Coding style is consistent with the rest of the framework.
  • 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.
  • Changes (and possible deprecations) have towncrier news fragments under docs/_newsfragments/, with the file name format {issue_number}.{fragment_type}.rst. (Run tox -e docs, and inspect docs/_build/html/changes/ in the browser to ensure it renders correctly.)
  • LLM output, if any, has been carefully reviewed and tested by a human developer. (See also: Use of LLMs ("AI").)

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

@vytas7 vytas7 changed the title Recipe custom error handling docs: add a recipe for custom error handling Jul 22, 2026
@vytas7 vytas7 added the EuroPython2026 Ideas for the Falcon Sprint label Jul 22, 2026
@codecov

codecov Bot commented Jul 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (46ab186) to head (3071ede).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #2701   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         7987      7987           
  Branches      1105      1105           
=========================================
  Hits          7987      7987           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

EuroPython2026 Ideas for the Falcon Sprint

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants