From 27f26b9967e5f1be4759f0a5ac33fbbd8f1092c3 Mon Sep 17 00:00:00 2001 From: Kurt Griffiths Date: Thu, 5 Feb 2015 11:17:13 -0600 Subject: [PATCH] doc(API): Fix markup errors in docstrings Add missing backticks around `resp`, and add missing colon introducing a sample code block. --- falcon/api.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/falcon/api.py b/falcon/api.py index 627149d..ff61dc1 100644 --- a/falcon/api.py +++ b/falcon/api.py @@ -353,7 +353,7 @@ class API(object): Note: A handler can either raise an instance of ``HTTPError`` - or modify resp manually in order to communicate + or modify `resp` manually in order to communicate information about the issue to the client. """ @@ -381,7 +381,7 @@ class API(object): The ``falcon.HTTPError`` class contains helper methods, such as `to_json()` and `to_dict()`, that can be used from within - custom serializers. For example: + custom serializers. For example:: def my_serializer(req, exception): representation = None