Skip to content

Commit

Permalink
docs(examples): improve code teaser in index page (#2241)
Browse files Browse the repository at this point in the history
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.

Co-authored-by: unsinn <[email protected]>
  • Loading branch information
M-Mueller and M-Mueller authored Jul 13, 2024
1 parent 89ccb98 commit c345420
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ while remaining highly effective.

.. code:: python
import falcon
class QuoteResource:
def on_get(self, req, resp):
Expand All @@ -36,6 +38,8 @@ while remaining highly effective.
app = falcon.App()
app.add_route('/quote', QuoteResource())
For a fully working example, check out the :ref:`quickstart`.

Quick Links
-----------

Expand Down

0 comments on commit c345420

Please sign in to comment.