Bug 1405325 - Correct HTTPWireProtocol#send documentation. r=maja_zf
authorAndreas Tolfsen <ato@sny.no>
Tue, 03 Oct 2017 16:24:22 +0100
changeset 432424 bd809f9f27e00566e114900b6d057f87733b352a
parent 432423 d06884758cb64b0226a0811fda273ff41f35ae51
child 432425 9a13140630882d966dc1e41f23d6540d54afcc6a
push id7953
push userryanvm@gmail.com
push dateThu, 12 Oct 2017 14:05:58 +0000
treeherdermozilla-beta@f4ba99b41183 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmaja_zf
bugs1405325
milestone57.0
Bug 1405325 - Correct HTTPWireProtocol#send documentation. r=maja_zf MozReview-Commit-ID: 3ZfXYHOaKRC
testing/web-platform/tests/tools/webdriver/webdriver/transport.py
--- 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")