Bug 1405325 - Correct HTTPWireProtocol#send documentation. r=maja_zf
MozReview-Commit-ID: 3ZfXYHOaKRC
--- a/testing/web-platform/tests/tools/webdriver/webdriver/transport.py
+++ b/testing/web-platform/tests/tools/webdriver/webdriver/transport.py
@@ -63,25 +63,26 @@ class HTTPWireProtocol(object):
self._timeout = timeout
def url(self, suffix):
return urlparse.urljoin(self.url_prefix, suffix)
def send(self, method, uri, body=None, headers=None):
"""Send a command to the remote.
- :param method: "POST" or "GET".
- :param url: "command part" of the requests URL path
- :param body: Body of the request. Defaults to an empty dictionary
- if ``method`` is "POST".
+ :param method: `GET`, `POST`, or `DELETE`.
+ :param uri: Relative endpoint of the requests URL path.
+ :param body: Body of the request. Defaults to an empty
+ dictionary if ``method`` is `POST`.
:param headers: Additional headers to include in the request.
- :return: an instance of wdclient.Response describing the HTTP response
- received from the remote end.
+
+ :return: Instance of ``wdclient.Response`` describing the
+ HTTP response received from the remote end.
+
"""
-
if body is None and method == "POST":
body = {}
if isinstance(body, dict):
body = json.dumps(body, cls=ToJsonEncoder)
if isinstance(body, unicode):
body = body.encode("utf-8")