diff options
| author | Paul "LeoNerd" Evans <paul@matrix.org> | 2014-08-13 15:52:47 +0100 |
|---|---|---|
| committer | Paul "LeoNerd" Evans <paul@matrix.org> | 2014-08-13 17:23:49 +0100 |
| commit | 1ddae5f40bf21faa95a4a15aaca2d4ba4458b312 (patch) | |
| tree | 86da3b09842112ad6d2b2c202a3c00a0345a1ff2 /synapse | |
| parent | Handle a potential race in the notifier when calling get_events_for which res... (diff) | |
| download | synapse-1ddae5f40bf21faa95a4a15aaca2d4ba4458b312.tar.xz | |
Update get_json()'s documentation to match the actual observed behaviour
Diffstat (limited to 'synapse')
| -rw-r--r-- | synapse/http/client.py | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/synapse/http/client.py b/synapse/http/client.py index d0facbdc6c..5c73d62cfd 100644 --- a/synapse/http/client.py +++ b/synapse/http/client.py @@ -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 |