Update get_json()'s documentation to match the actual observed behaviour

This commit is contained in:
Paul "LeoNerd" Evans 2014-08-13 15:52:47 +01:00
parent 6df83555cc
commit 1ddae5f40b
1 changed files with 3 additions and 4 deletions

View File

@ -55,10 +55,9 @@ class HttpClient(object):
the request body. This will be encoded as JSON.
Returns:
Deferred: Succeeds when we get *any* HTTP response.
The result of the deferred is a tuple of `(code, response)`,
where `response` is a dict representing the decoded JSON body.
Deferred: Succeeds when we get a 2xx HTTP response. The result
will be the decoded JSON body. On a 4xx or 5xx error response a
CodeMessageException is raised.
"""
pass