From 1ddae5f40bf21faa95a4a15aaca2d4ba4458b312 Mon Sep 17 00:00:00 2001
From: "Paul \"LeoNerd\" Evans" <paul@matrix.org>
Date: Wed, 13 Aug 2014 15:52:47 +0100
Subject: [PATCH] Update get_json()'s documentation to match the actual
observed behaviour
---
synapse/http/client.py | 7 +++----
1 file 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
--
GitLab