refactor: update documentation format in ErrorHandler and SwitchTo classes

Author: iampopovich

py/selenium/webdriver/remote/errorhandler.py

@@ -53,9 +53,9 @@
 
 
 class ExceptionMapping:
-    """
-    :Maps each errorcode in ErrorCode object to corresponding exception
-    Please refer to https://www.w3.org/TR/webdriver2/#errors for w3c specification
+    """Maps each errorcode in ErrorCode object to corresponding exception.
+
+    Please refer to https://www.w3.org/TR/webdriver2/#errors for w3c specification.
     """
 
     NO_SUCH_ELEMENT = NoSuchElementException
@@ -146,11 +146,12 @@ def check_response(self, response: dict[str, Any]) -> None:
         """Checks that a JSON response from the WebDriver does not have an
         error.
 
-        :Args:
-         - response - The JSON response from the WebDriver server as a dictionary
-           object.
+        Args:
+            response: The JSON response from the WebDriver server as a dictionary
+                object.
 
-        :Raises: If the response contains an error message.
+        Raises:
+            WebDriverException: If the response contains an error message.
         """
         status = response.get("status", None)
         if not status or status == ErrorCode.SUCCESS:

py/selenium/webdriver/remote/switch_to.py

@@ -34,21 +34,17 @@ def __init__(self, driver) -> None:
     def active_element(self) -> WebElement:
         """Returns the element with focus, or BODY if nothing has focus.
 
-        :Usage:
-            ::
-
-                element = driver.switch_to.active_element
+        Example:
+            element = driver.switch_to.active_element
         """
         return self._driver.execute(Command.W3C_GET_ACTIVE_ELEMENT)["value"]
 
     @property
     def alert(self) -> Alert:
         """Switches focus to an alert on the page.
 
-        :Usage:
-            ::
-
-                alert = driver.switch_to.alert
+        Example:
+            alert = driver.switch_to.alert
         """
         alert = Alert(self._driver)
         _ = alert.text
@@ -57,24 +53,20 @@ def alert(self) -> Alert:
     def default_content(self) -> None:
         """Switch focus to the default frame.
 
-        :Usage:
-            ::
-
-                driver.switch_to.default_content()
+        Example:
+            driver.switch_to.default_content()
         """
         self._driver.execute(Command.SWITCH_TO_FRAME, {"id": None})
 
     def frame(self, frame_reference: Union[str, int, WebElement]) -> None:
         """Switches focus to the specified frame, by index, name, or
         webelement.
 
-        :Args:
-         - frame_reference: The name of the window to switch to, an integer representing the index,
-                            or a webelement that is an (i)frame to switch to.
-
-        :Usage:
-            ::
+        Args:
+            frame_reference: The name of the window to switch to, an integer representing the index,
+                or a webelement that is an (i)frame to switch to.
 
+        Example:
                 driver.switch_to.frame("frame_name")
                 driver.switch_to.frame(1)
                 driver.switch_to.frame(driver.find_elements(By.TAG_NAME, "iframe")[0])
@@ -96,9 +88,7 @@ def new_window(self, type_hint: Optional[str] = None) -> None:
         The type hint can be one of "tab" or "window". If not specified the
         browser will automatically select it.
 
-        :Usage:
-            ::
-
+        Example:
                 driver.switch_to.new_window("tab")
         """
         value = self._driver.execute(Command.NEW_WINDOW, {"type": type_hint})["value"]
@@ -108,23 +98,19 @@ def parent_frame(self) -> None:
         """Switches focus to the parent context. If the current context is the
         top level browsing context, the context remains unchanged.
 
-        :Usage:
-            ::
-
+        Example:
                 driver.switch_to.parent_frame()
         """
         self._driver.execute(Command.SWITCH_TO_PARENT_FRAME)
 
     def window(self, window_name: str) -> None:
         """Switches focus to the specified window.
 
-        :Args:
-         - window_name: The name or window handle of the window to switch to.
-
-        :Usage:
-            ::
+        Args:
+            window_name: The name or window handle of the window to switch to.
 
-                driver.switch_to.window("main")
+        Example:
+            driver.switch_to.window("main")
         """
         self._w3c_window(window_name)