doc(API): Fix markup errors in docstrings

Add missing backticks around `resp`, and add missing colon introducing
a sample code block.
This commit is contained in:
Kurt Griffiths
2015-02-05 11:17:13 -06:00
parent a605a81290
commit 27f26b9967

View File

@@ -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