falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.51k stars 937 forks source link

docs(examples): improve code teaser in index page #2241

Closed M-Mueller closed 2 months ago

M-Mueller commented 2 months ago

Summary of Changes

Running the very first example in the documentation no longer results in a NameError. Additionally there is a link to the Quickstart for a full example.

Related Issues

N/A

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it 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.

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.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (89ccb98) to head (9e827aa).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2241 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 63 63 Lines 6889 6889 Branches 1258 1258 ========================================= Hits 6889 6889 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.