Bug 1410799 - Fix API docs for assert_error and assert_success r=jgraham draft
authorAndreas Tolfsen <ato@sny.no>
Wed, 01 Nov 2017 18:00:49 +0000
changeset 692108 407fa8e6335f07eac0ac24bcad0711be4500e0be
parent 692107 1ac55eb8695ec3cecd4b0ee35c84e0938c593bbe
child 692109 53f0b32914046993a720c5396b0ec03ae1248d20
push id87400
push userbmo:ato@sny.no
push dateThu, 02 Nov 2017 15:42:41 +0000
reviewersjgraham
bugs1410799
milestone58.0a1
Bug 1410799 - Fix API docs for assert_error and assert_success r=jgraham wdclient was the name of the old GitHub repository. The actual Python package name is "webdriver". MozReview-Commit-ID: FHy3iEB9aAj
testing/web-platform/tests/webdriver/tests/support/asserts.py
--- a/testing/web-platform/tests/webdriver/tests/support/asserts.py
+++ b/testing/web-platform/tests/webdriver/tests/support/asserts.py
@@ -49,38 +49,39 @@ errors = {
 # >         name
 # >     message
 # >         message
 # >     stacktrace
 # >         stacktrace
 # >
 # > 5. Send a response with status and data as arguments.
 def assert_error(response, error_code):
-    """Verify that the provided wdclient.Response instance described a valid
-    error response as defined by `dfn-send-an-error` and the provided error
-    code.
+    """
+    Verify that the provided webdriver.Response instance described
+    a valid error response as defined by `dfn-send-an-error` and
+    the provided error code.
 
-    :param response: wdclient.Response instance
-    :param error_code: string value of the expected "error code"
+    :param response: ``webdriver.Response`` instance.
+    :param error_code: String value of the expected error code
     """
     assert response.status == errors[error_code]
     assert "value" in response.body
     assert response.body["value"]["error"] == error_code
     assert isinstance(response.body["value"]["message"], basestring)
     assert isinstance(response.body["value"]["stacktrace"], basestring)
 
 
 def assert_success(response, value=None):
-    """Verify that the provided wdclient.Response instance described a valid
-    error response as defined by `dfn-send-an-error` and the provided error
-    code.
+    """
+    Verify that the provided webdriver.Response instance described
+    a valid error response as defined by `dfn-send-an-error` and
+    the provided error code.
 
-    :param response: wdclient.Response instance.
+    :param response: ``webdriver.Response`` instance.
     :param value: Expected value of the response body, if any.
-
     """
     assert response.status == 200, str(response.error)
 
     if value is not None:
         assert response.body["value"] == value
     return response.body.get("value")