diff options
| author | Richard van der Hoff <richard@matrix.org> | 2017-04-21 00:46:54 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2017-04-21 01:31:09 +0100 |
| commit | 4903ccf159552319a36708069c8eb52ce53542dd (patch) | |
| tree | 3f1482b18195c396dd1ab419f5d65ad43e28493c /contrib/cmdclient/http.py | |
| parent | m.read_marker -> m.fully_read (#2128) (diff) | |
| download | synapse-4903ccf159552319a36708069c8eb52ce53542dd.tar.xz | |
Fix some lies, and other clarifications, in docstrings
The documentation on get_json has been wrong ever since the very first commit to synapse...
Diffstat (limited to 'contrib/cmdclient/http.py')
| -rw-r--r-- | contrib/cmdclient/http.py | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/contrib/cmdclient/http.py b/contrib/cmdclient/http.py index 4186897316..c833f3f318 100644 --- a/contrib/cmdclient/http.py +++ b/contrib/cmdclient/http.py @@ -36,15 +36,13 @@ 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. """ pass def get_json(self, url, args=None): - """ Get's some json from the given host homeserver and path + """ Gets some json from the given host homeserver and path Args: url (str): The URL to GET data from. @@ -54,10 +52,8 @@ class HttpClient(object): and *not* a string. 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. """ pass @@ -214,4 +210,4 @@ class _JsonProducer(object): pass def stopProducing(self): - pass \ No newline at end of file + pass |