clarification

Author: shbenzer

py/selenium/webdriver/remote/webdriver.py

@@ -90,7 +90,7 @@ def _create_caps(caps):
     Moves the Firefox profile, if present, from the old location to the new Firefox
     options object.
 
-    Attributes:
+    Parameters:
     ----------
     caps : dict
         - A dictionary of capabilities requested by the caller.
@@ -201,7 +201,7 @@ def __init__(
         """Create a new driver that will issue commands using the wire
         protocol.
 
-        Attributes:
+        Parameters:
         ----------
         command_executor : str or remote_connection.RemoteConnection
             - Either a string representing the URL of the remote server or a custom
@@ -272,7 +272,7 @@ def file_detector_context(self, file_detector_class, *args, **kwargs):
         """Overrides the current file detector (if necessary) in limited
         context. Ensures the original file detector is set afterwards.
 
-        Attributes:
+        Parameters:
         ----------
         file_detector_class : object
             - Class of the desired file detector. If the class is different
@@ -332,7 +332,7 @@ def stop_client(self):
     def start_session(self, capabilities: dict) -> None:
         """Creates a new session with the desired capabilities.
 
-        Attributes:
+        Parameters:
         ----------
         capabilities : dict
             - A capabilities dict to start the session with.
@@ -380,7 +380,7 @@ def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
         domains/commands, refer to link
         https://chromedevtools.github.io/devtools-protocol/
 
-        Attributes:
+        Parameters:
         ----------
         cmd : str,
             - Command name
@@ -403,12 +403,12 @@ def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
     def execute(self, driver_command: str, params: dict = None) -> dict:
         """Sends a command to be executed by a command.CommandExecutor.
 
-        Attributes:
+        Parameters:
         ----------
         driver_command : str
             - The name of the command to execute as a string.
         params : dict
-            - A dictionary of named Attributes to send with the command.
+            - A dictionary of named Parameters to send with the command.
 
         Returns:
         --------
@@ -438,7 +438,7 @@ def get(self, url: str) -> None:
         The method does not return until the page is fully loaded (i.e. the
         onload event has fired).
 
-        Attributes:
+        Parameters:
         ----------
         url : str
             - The URL to be opened by the browser.
@@ -498,7 +498,7 @@ def get_pinned_scripts(self) -> List[str]:
     def execute_script(self, script, *args):
         """Synchronously Executes JavaScript in the current window/frame.
 
-        Attributes:
+        Parameters:
         ----------
         script : str
             - The javascript to execute.
@@ -527,7 +527,7 @@ def execute_script(self, script, *args):
     def execute_async_script(self, script: str, *args):
         """Asynchronously Executes JavaScript in the current window/frame.
 
-        Attributes:
+        Parameters:
         ----------
         script : str
             - The javascript to execute.
@@ -634,7 +634,7 @@ def print_page(self, print_options: Optional[PrintOptions] = None) -> str:
         """Takes PDF of the current page.
 
         The driver makes a best effort to return a PDF based on the
-        provided Attributes.
+        provided Parameters.
 
         Example:
         --------
@@ -743,7 +743,7 @@ def delete_all_cookies(self) -> None:
     def add_cookie(self, cookie_dict) -> None:
         """Adds a cookie to your current session.
 
-        Attributes:
+        Parameters:
         ----------
         cookie_dict : dict
             - A dictionary object, with required keys - "name" and "value";
@@ -769,7 +769,7 @@ def implicitly_wait(self, time_to_wait: float) -> None:
         per session. To set the timeout for calls to execute_async_script, see
         set_script_timeout.
 
-        Attributes:
+        Parameters:
         ----------
         time_to_wait : float
             - Amount of time to wait (in seconds)
@@ -784,7 +784,7 @@ def set_script_timeout(self, time_to_wait: float) -> None:
         """Set the amount of time that the script should wait during an
         execute_async_script call before throwing an error.
 
-        Attributes:
+        Parameters:
         ---------
         time_to_wait : float
             - The amount of time to wait (in seconds)
@@ -799,7 +799,7 @@ def set_page_load_timeout(self, time_to_wait: float) -> None:
         """Set the amount of time to wait for a page load to complete before
         throwing an error.
 
-        Attributes:
+        Parameters:
          ---------
          time_to_wait : float
              - The amount of time to wait (in seconds)
@@ -850,7 +850,7 @@ def timeouts(self, timeouts) -> None:
     def find_element(self, by=By.ID, value: Optional[str] = None) -> WebElement:
         """Find an element given a By strategy and locator.
 
-        Attributes:
+        Parameters:
         ----------
         by : selenium.webdriver.common.by.By
             The locating strategy to use. Default is `By.ID`. Supported values include:
@@ -886,7 +886,7 @@ def find_element(self, by=By.ID, value: Optional[str] = None) -> WebElement:
     def find_elements(self, by=By.ID, value: Optional[str] = None) -> List[WebElement]:
         """Find elements given a By strategy and locator.
 
-        Attributes:
+        Parameters:
         ----------
         by : selenium.webdriver.common.by.By
             The locating strategy to use. Default is `By.ID`. Supported values include:
@@ -936,7 +936,7 @@ def get_screenshot_as_file(self, filename) -> bool:
         Returns False if there is any IOError, else returns True. Use full
         paths in your filename.
 
-        Attributes:
+        Parameters:
         ----------
         filename : str
             - The full path you wish to save your screenshot to. This
@@ -967,7 +967,7 @@ def save_screenshot(self, filename) -> bool:
         Returns False if there is any IOError, else returns True. Use full
         paths in your filename.
 
-        Attributes:
+        Parameters:
         ----------
         filename : str
             - The full path you wish to save your screenshot to. This
@@ -1001,7 +1001,7 @@ def get_screenshot_as_base64(self) -> str:
     def set_window_size(self, width, height, windowHandle: str = "current") -> None:
         """Sets the width and height of the current window. (window.resizeTo)
 
-        Attributes:
+        Parameters:
         ----------
         width : int
             - the width in pixels to set the window to
@@ -1034,7 +1034,7 @@ def get_window_size(self, windowHandle: str = "current") -> dict:
     def set_window_position(self, x: float, y: float, windowHandle: str = "current") -> dict:
         """Sets the x,y position of the current window. (window.moveTo)
 
-        Attributes:
+        Parameters:
         ---------
         x : float
             - The x-coordinate in pixels to set the window position
@@ -1107,7 +1107,7 @@ def file_detector(self, detector) -> None:
         - see LocalFileDetector
         - see UselessFileDetector
 
-        Attributes:
+        Parameters:
         ----------
         detector : Any
             - The detector to use. Must not be None.
@@ -1132,7 +1132,7 @@ def orientation(self):
     def orientation(self, value) -> None:
         """Sets the current orientation of the device.
 
-        Attributes:
+        Parameters:
         ----------
         value : str
             - orientation to set it to.
@@ -1161,7 +1161,7 @@ def log_types(self):
     def get_log(self, log_type):
         """Gets the log for a given log type.
 
-        Attributes:
+        Parameters:
         ----------
         log_type : str
             - Type of log that which will be returned
@@ -1367,7 +1367,7 @@ def set_user_verified(self, verified: bool) -> None:
         """Sets whether the authenticator will simulate success or fail on user
         verification.
 
-        Attributes:
+        Parameters:
         ----------
         verified: True if the authenticator will pass user verification, False otherwise.
 
@@ -1394,7 +1394,7 @@ def download_file(self, file_name: str, target_directory: str) -> None:
         """Downloads a file with the specified file name to the target
         directory.
 
-        Attributes:
+        Parameters:
         ----------
         file_name : str
             - The name of the file to download.
@@ -1489,7 +1489,7 @@ def dialog(self):
     def fedcm_dialog(self, timeout=5, poll_frequency=0.5, ignored_exceptions=None):
         """Waits for and returns the FedCM dialog.
 
-        Attributes:
+        Parameters:
         ----------
         timeout : int
             - How long to wait for the dialog