Refactor docstrings in ChromiumDriver for consistency and clarity

Author: iampopovich

py/selenium/webdriver/chromium/webdriver.py

@@ -40,12 +40,12 @@ def __init__(
         """Creates a new WebDriver instance of the ChromiumDriver. Starts the
         service and then creates new WebDriver instance of ChromiumDriver.
 
-        :Args:
-         - browser_name - Browser name used when matching capabilities.
-         - vendor_prefix - Company prefix to apply to vendor-specific WebDriver extension commands.
-         - options - this takes an instance of ChromiumOptions
-         - service - Service object for handling the browser driver if you need to pass extra details
-         - keep_alive - Whether to configure ChromiumRemoteConnection to use HTTP keep-alive.
+        Args:
+            browser_name: Browser name used when matching capabilities.
+            vendor_prefix: Company prefix to apply to vendor-specific WebDriver extension commands.
+            options: This takes an instance of ChromiumOptions.
+            service: Service object for handling the browser driver if you need to pass extra details.
+            keep_alive: Whether to configure ChromiumRemoteConnection to use HTTP keep-alive.
         """
 
         self.service = service if service else ChromiumService()
@@ -76,33 +76,34 @@ def __init__(
         self._is_remote = False
 
     def launch_app(self, id):
-        """Launches Chromium app specified by id."""
+        """Launches Chromium app specified by id.
+
+        Args:
+            id: The id of the Chromium app to launch.
+        """
         return self.execute("launchApp", {"id": id})
 
     def get_network_conditions(self):
         """Gets Chromium network emulation settings.
 
-        :Returns:
-            A dict.
-            For example:     {'latency': 4, 'download_throughput': 2, 'upload_throughput': 2, 'offline': False}
+        Returns:
+            A dict. For example: {'latency': 4, 'download_throughput': 2, 'upload_throughput': 2}
         """
         return self.execute("getNetworkConditions")["value"]
 
     def set_network_conditions(self, **network_conditions) -> None:
         """Sets Chromium network emulation settings.
 
-        :Args:
-         - network_conditions: A dict with conditions specification.
-
-        :Usage:
-            ::
+        Args:
+            **network_conditions: A dict with conditions specification.
 
-                driver.set_network_conditions(
-                    offline=False,
-                    latency=5,  # additional latency (ms)
-                    download_throughput=500 * 1024,  # maximal throughput
-                    upload_throughput=500 * 1024,
-                )  # maximal throughput
+        Example:
+            driver.set_network_conditions(
+                offline=False,
+                latency=5,  # additional latency (ms)
+                download_throughput=500 * 1024,  # maximal throughput
+                upload_throughput=500 * 1024,
+            )  # maximal throughput
 
             Note: 'throughput' can be used to set both (for download and upload).
         """
@@ -115,14 +116,12 @@ def delete_network_conditions(self) -> None:
     def set_permissions(self, name: str, value: str) -> None:
         """Sets Applicable Permission.
 
-        :Args:
-         - name: The item to set the permission on.
-         - value: The value to set on the item
-
-        :Usage:
-            ::
+        Args:
+            name: The item to set the permission on.
+            value: The value to set on the item
 
-                driver.set_permissions("clipboard-read", "denied")
+        Example:
+            driver.set_permissions("clipboard-read", "denied")
         """
         self.execute("setPermissions", {"descriptor": {"name": name}, "state": value})
 
@@ -132,26 +131,26 @@ def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
         domains/commands, refer to link
         https://chromedevtools.github.io/devtools-protocol/
 
-        :Args:
-         - cmd: A str, command name
-         - cmd_args: A dict, command args. empty dict {} if there is no command args
-        :Usage:
-            ::
+        Args:
+            cmd: A str, command name
+            cmd_args: A dict, command args. empty dict {} if there is no command args
+
+        Example:
+            driver.execute_cdp_cmd('Network.getResponseBody', {'requestId': requestId})
 
-                driver.execute_cdp_cmd('Network.getResponseBody', {'requestId': requestId})
-        :Returns:
+        Returns:
             A dict, empty dict {} if there is no result to return.
             For example to getResponseBody:
             {'base64Encoded': False, 'body': 'response body string'}
         """
         return super().execute_cdp_cmd(cmd, cmd_args)
 
     def get_sinks(self) -> list:
-        """:Returns: A list of sinks available for Cast."""
+        """Returns: A list of sinks available for Cast."""
         return self.execute("getSinks")["value"]
 
     def get_issue_message(self):
-        """:Returns: An error message when there is any issue in a Cast
+        """Returns: An error message when there is any issue in a Cast
         session."""
         return self.execute("getIssueMessage")["value"]
 
@@ -168,50 +167,47 @@ def log_types(self):
     def get_log(self, log_type):
         """Gets the log for a given log type.
 
-        Parameters:
-        -----------
-        log_type : str
-            - Type of log that which will be returned
+        Args:
+            log_type: Type of log that which will be returned
 
         Example:
-        --------
-        >>> driver.get_log("browser")
-        >>> driver.get_log("driver")
-        >>> driver.get_log("client")
-        >>> driver.get_log("server")
+            >>> driver.get_log("browser")
+            >>> driver.get_log("driver")
+            >>> driver.get_log("client")
+            >>> driver.get_log("server")
         """
         return self.execute(Command.GET_LOG, {"type": log_type})["value"]
 
     def set_sink_to_use(self, sink_name: str) -> dict:
         """Sets a specific sink, using its name, as a Cast session receiver
         target.
 
-        :Args:
-         - sink_name: Name of the sink to use as the target.
+        Args:
+            sink_name: Name of the sink to use as the target.
         """
         return self.execute("setSinkToUse", {"sinkName": sink_name})
 
     def start_desktop_mirroring(self, sink_name: str) -> dict:
         """Starts a desktop mirroring session on a specific receiver target.
 
-        :Args:
-         - sink_name: Name of the sink to use as the target.
+        Args:
+            sink_name: Name of the sink to use as the target.
         """
         return self.execute("startDesktopMirroring", {"sinkName": sink_name})
 
     def start_tab_mirroring(self, sink_name: str) -> dict:
         """Starts a tab mirroring session on a specific receiver target.
 
-        :Args:
-         - sink_name: Name of the sink to use as the target.
+        Args:
+            sink_name: Name of the sink to use as the target.
         """
         return self.execute("startTabMirroring", {"sinkName": sink_name})
 
     def stop_casting(self, sink_name: str) -> dict:
         """Stops the existing Cast session on a specific receiver target.
 
-        :Args:
-         - sink_name: Name of the sink to stop the Cast session.
+        Args:
+            sink_name: Name of the sink to stop the Cast session.
         """
         return self.execute("stopCasting", {"sinkName": sink_name})
 
@@ -226,10 +222,13 @@ def quit(self) -> None:
             self.service.stop()
 
     def download_file(self, *args, **kwargs):
+        """Download file functionality is not implemented for Chromium driver."""
         raise NotImplementedError
 
     def get_downloadable_files(self, *args, **kwargs):
+        """Get downloadable files functionality is not implemented for Chromium driver."""
         raise NotImplementedError
 
     def delete_downloadable_files(self, *args, **kwargs):
+        """Delete downloadable files functionality is not implemented for Chromium driver."""
         raise NotImplementedError