kaslo/synapse
1
0
Fork 0
Code Packages Releases 124 Wiki Activity

Fix some lies, and other clarifications, in docstrings

Browse Source 
The documentation on get_json has been wrong ever since the very first commit
to synapse...
This commit is contained in:
Richard van der Hoff
2017-04-21 00:46:54 +01:00
parent 3fb8784c92
commit 4903ccf159
4 changed files with 88 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
contrib/cmdclient/http.py
View File

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