refactor: update parameter documentation to use 'Args' format for consistency across options and server classes

Author: iampopovich

py/selenium/webdriver/common/options.py

@@ -163,266 +163,168 @@ class BaseOptions(metaclass=ABCMeta):
     """Gets and Sets the version of the browser.
 
     Usage:
-    ------
-    - Get
-        - `self.browser_version`
-    - Set
-        - `self.browser_version` = `value`
+        - Get: `self.browser_version`
+        - Set: `self.browser_version = value`
 
-    Parameters:
-    -----------
-    `value`: `str`
+    Args:
+        value: str
 
     Returns:
-    --------
-    - Get
-        - `str`
-    - Set
-        - `None`
+        str when getting, None when setting.
     """
 
     platform_name = _BaseOptionsDescriptor("platformName")
     """Gets and Sets name of the platform.
 
     Usage:
-    ------
-    - Get
-        - `self.platform_name`
-    - Set
-        - `self.platform_name` = `value`
+        - Get: `self.platform_name`
+        - Set: `self.platform_name = value`
 
-    Parameters:
-    -----------
-    `value`: `str`
+    Args:
+        value: str
 
     Returns:
-    --------
-    - Get
-        - `str`
-    - Set
-        - `None`
+        str when getting, None when setting.
     """
 
     accept_insecure_certs = _BaseOptionsDescriptor("acceptInsecureCerts")
     """Gets and Set whether the session accepts insecure certificates.
 
     Usage:
-    ------
-    - Get
-        - `self.accept_insecure_certs`
-    - Set
-        - `self.accept_insecure_certs` = `value`
+        - Get: `self.accept_insecure_certs`
+        - Set: `self.accept_insecure_certs = value`
 
-    Parameters:
-    -----------
-    `value`: `bool`
+    Args:
+        value: bool
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
-    strict_file_interactability = _BaseOptionsDescriptor("strictFileInteractability")
+    strict_file_interactability : o = _BaseOptionsDescriptor("strictFileInteractability")
     """Gets and Sets whether session is about file interactability.
 
     Usage:
-    ------
-    - Get
-        - `self.strict_file_interactability`
-    - Set
-        - `self.strict_file_interactability` = `value`
+        - Get: `self.strict_file_interactability`
+        - Set: `self.strict_file_interactability = value`
 
-    Parameters:
-    -----------
-    `value`: `bool`
+    Args:
+        value: bool
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
     set_window_rect = _BaseOptionsDescriptor("setWindowRect")
     """Gets and Sets window size and position.
 
     Usage:
-    ------
-    - Get
-        - `self.set_window_rect`
-    - Set
-        - `self.set_window_rect` = `value`
+        - Get: `self.set_window_rect`
+        - Set: `self.set_window_rect = value`
 
-    Parameters:
-    -----------
-    `value`: `bool`
+    Args:
+        value: bool
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
     enable_bidi = _BaseOptionsDescriptor("enableBidi")
     """Gets and Set whether the session has WebDriverBiDi enabled.
 
     Usage:
-    ------
-    - Get
-        - `self.enable_bidi`
-    - Set
-        - `self.enable_bidi` = `value`
+        - Get: `self.enable_bidi`
+        - Set: `self.enable_bidi = value`
 
-    Parameters:
-    -----------
-    `value`: `bool`
+    Args:
+        value: bool
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
     page_load_strategy = _PageLoadStrategyDescriptor("pageLoadStrategy")
-    """:Gets and Sets page load strategy, the default is "normal".
+    """Gets and Sets page load strategy, the default is "normal".
 
     Usage:
-    ------
-    - Get
-        - `self.page_load_strategy`
-    - Set
-        - `self.page_load_strategy` = `value`
+        - Get: `self.page_load_strategy`
+        - Set: `self.page_load_strategy = value`
 
-    Parameters:
-    -----------
-    `value`: `str`
+    Args:
+        value: str
 
     Returns:
-    --------
-    - Get
-        - `str`
-    - Set
-        - `None`
+        str when getting, None when setting.
     """
 
     unhandled_prompt_behavior = _UnHandledPromptBehaviorDescriptor("unhandledPromptBehavior")
-    """:Gets and Sets unhandled prompt behavior, the default is "dismiss and
-    notify".
+    """Gets and Sets unhandled prompt behavior, the default is "dismiss and notify".
 
     Usage:
-    ------
-    - Get
-        - `self.unhandled_prompt_behavior`
-    - Set
-        - `self.unhandled_prompt_behavior` = `value`
+        - Get: `self.unhandled_prompt_behavior`
+        - Set: `self.unhandled_prompt_behavior = value`
 
-    Parameters:
-    -----------
-    `value`: `str`
+    Args:
+        value: str
 
     Returns:
-    --------
-    - Get
-        - `str`
-    - Set
-        - `None`
+        str when getting, None when setting.
     """
 
     timeouts = _TimeoutsDescriptor("timeouts")
-    """:Gets and Sets implicit timeout, pageLoad timeout and script timeout if
-    set (in milliseconds)
+    """Gets and Sets implicit timeout, pageLoad timeout and script timeout if set (in milliseconds).
 
     Usage:
-    ------
-    - Get
-        - `self.timeouts`
-    - Set
-        - `self.timeouts` = `value`
+        - Get: `self.timeouts`
+        - Set: `self.timeouts = value`
 
-    Parameters:
-    -----------
-    `value`: `dict`
+    Args:
+        value: dict
 
     Returns:
-    --------
-    - Get
-        - `dict`
-    - Set
-        - `None`
+        dict when getting, None when setting.
     """
 
     proxy = _ProxyDescriptor("proxy")
     """Sets and Gets Proxy.
 
     Usage:
-    ------
-    - Get
-        - `self.proxy`
-    - Set
-        - `self.proxy` = `value`
+        - Get: `self.proxy`
+        - Set: `self.proxy = value`
 
-    Parameters:
-    -----------
-    `value`: `Proxy`
+    Args:
+        value: Proxy
 
     Returns:
-    --------
-    - Get
-        - `Proxy`
-    - Set
-        - `None`
+        Proxy when getting, None when setting.
     """
 
     enable_downloads = _BaseOptionsDescriptor("se:downloadsEnabled")
     """Gets and Sets whether session can download files.
 
     Usage:
-    ------
-    - Get
-        - `self.enable_downloads`
-    - Set
-        - `self.enable_downloads` = `value`
+        - Get: `self.enable_downloads`
+        - Set: `self.enable_downloads = value`
 
-    Parameters:
-    -----------
-    `value`: `bool`
+    Args:
+        value: bool
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
     web_socket_url = _BaseOptionsDescriptor("webSocketUrl")
     """Gets and Sets WebSocket URL.
 
     Usage:
-    ------
-    - Get
-        - `self.web_socket_url`
-    - Set
-        - `self.web_socket_url` = `value`
+        - Get: `self.web_socket_url`
+        - Set: `self.web_socket_url = value`
 
-    Parameters:
-    -----------
-    `value`: `str`
+    Args:
+        value: str
 
     Returns:
-    --------
-    - Get
-        - `bool`
-    - Set
-        - `None`
+        bool when getting, None when setting.
     """
 
     def __init__(self) -> None: