refactor: standardize argument documentation format in IE options and webdriver classes

Author: iampopovich

py/selenium/webdriver/ie/options.py

@@ -27,9 +27,9 @@ class ElementScrollBehavior(Enum):
 
 
 class _IeOptionsDescriptor:
-    """_IeOptionsDescriptor is an implementation of Descriptor Protocol:
+    """_IeOptionsDescriptor is an implementation of Descriptor Protocol.
 
-    : Any look-up or assignment to the below attributes in `Options` class will be intercepted
+    Any look-up or assignment to the below attributes in `Options` class will be intercepted
     by `__get__` and `__set__` method respectively.
 
     - `browser_attach_timeout`
@@ -50,13 +50,15 @@ class _IeOptionsDescriptor:
     - `attach_to_edge_chrome`
     - `edge_executable_path`
 
+    When an attribute lookup happens:
 
-    : When an attribute lookup happens,
     Example:
         `self. browser_attach_timeout`
         `__get__` method does a dictionary look up in the dictionary `_options` in `Options` class
         and returns the value of key `browserAttachTimeout`
-    : When an attribute assignment happens,
+
+    When an attribute assignment happens:
+
     Example:
         `self.browser_attach_timeout` = 30
         `__set__` method sets/updates the value of the key `browserAttachTimeout` in `_options`
@@ -368,20 +370,26 @@ def __init__(self) -> None:
 
     @property
     def options(self) -> dict:
-        """:Returns: A dictionary of browser options."""
+        """
+        Returns:
+            A dictionary of browser options.
+        """
         return self._options
 
     @property
     def additional_options(self) -> dict:
-        """:Returns: The additional options."""
+        """
+        Returns:
+            The additional options.
+        """
         return self._additional
 
     def add_additional_option(self, name: str, value) -> None:
         """Adds an additional option not yet added as a safe option for IE.
 
-        :Args:
-         - name: name of the option to add
-         - value: value of the option to add
+        Args:
+            name: name of the option to add
+            value: value of the option to add
         """
         self._additional[name] = value
 

py/selenium/webdriver/ie/service.py

@@ -38,16 +38,16 @@ def __init__(
     ) -> None:
         """Creates a new instance of the Service.
 
-        :Args:
-         - executable_path : Path to the IEDriver
-         - port : Port the service is running on
-         - host : (Optional) IP address the service port is bound
-         - service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
-         - log_level : (Optional) Level of logging of service, may be "FATAL", "ERROR", "WARN", "INFO", "DEBUG",
-           "TRACE". Default is "FATAL".
-         - log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
-           Default is "stdout".
-         - driver_path_env_key: (Optional) Environment variable to use to get the path to the driver executable.
+        Args:
+            executable_path: Path to the IEDriver
+            port: Port the service is running on
+            host: (Optional) IP address the service port is bound
+            service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
+            log_level: (Optional) Level of logging of service, may be "FATAL", "ERROR", "WARN", "INFO", "DEBUG",
+                "TRACE". Default is "FATAL".
+            log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
+                Default is "stdout".
+            driver_path_env_key: (Optional) Environment variable to use to get the path to the driver executable.
         """
         self._service_args = list(service_args or [])
         driver_path_env_key = driver_path_env_key or "SE_IEDRIVER"

py/selenium/webdriver/ie/webdriver.py

@@ -39,10 +39,10 @@ def __init__(
 
         Starts the service and then creates new instance of Ie driver.
 
-        :Args:
-         - options - IE Options instance, providing additional IE options
-         - service - (Optional) service instance for managing the starting and stopping of the driver.
-         - keep_alive - Whether to configure RemoteConnection to use HTTP keep-alive.
+        Args:
+            options: IE Options instance, providing additional IE options
+            service: (Optional) service instance for managing the starting and stopping of the driver.
+            keep_alive: Whether to configure RemoteConnection to use HTTP keep-alive.
         """
 
         self.service = service if service else Service()