Skip to content

Commit

Permalink
[py] Fixed Incorrect Tabbing in DocStrings (#15096)
Browse files Browse the repository at this point in the history
  • Loading branch information
shbenzer authored Jan 17, 2025
1 parent e3768fe commit 487b9a2
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
1 change: 1 addition & 0 deletions py/selenium/webdriver/common/actions/action_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ def add_pointer_input(self, kind: str, name: str) -> PointerInput:
- "mouse"
- "touch"
- "pen"
name : str
The name of the pointer input device.
Expand Down
9 changes: 9 additions & 0 deletions py/selenium/webdriver/remote/webdriver.py
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
----------
cmd : str,
- Command name
cmd_args : dict
- Command args
- Empty dict {} if there is no command args
Expand All @@ -407,6 +408,7 @@ def execute(self, driver_command: str, params: dict = None) -> dict:
----------
driver_command : str
- The name of the command to execute as a string.
params : dict
- A dictionary of named Parameters to send with the command.
Expand Down Expand Up @@ -502,6 +504,7 @@ def execute_script(self, script, *args):
----------
script : str
- The javascript to execute.
*args : tuple
- Any applicable arguments for your JavaScript.
Expand Down Expand Up @@ -531,6 +534,7 @@ def execute_async_script(self, script: str, *args):
----------
script : str
- The javascript to execute.
*args : tuple
- Any applicable arguments for your JavaScript.
Expand Down Expand Up @@ -1005,6 +1009,7 @@ def set_window_size(self, width, height, windowHandle: str = "current") -> None:
----------
width : int
- the width in pixels to set the window to
height : int
- the height in pixels to set the window to
Expand Down Expand Up @@ -1038,6 +1043,7 @@ def set_window_position(self, x: float, y: float, windowHandle: str = "current")
---------
x : float
- The x-coordinate in pixels to set the window position
y : float
- The y-coordinate in pixels to set the window position
Expand Down Expand Up @@ -1398,6 +1404,7 @@ def download_file(self, file_name: str, target_directory: str) -> None:
----------
file_name : str
- The name of the file to download.
target_directory : str
- The path to the directory to save the downloaded file.
Expand Down Expand Up @@ -1493,8 +1500,10 @@ def fedcm_dialog(self, timeout=5, poll_frequency=0.5, ignored_exceptions=None):
----------
timeout : int
- How long to wait for the dialog
poll_frequency : floatHow
- Frequently to poll
ignored_exceptions : Any
- Exceptions to ignore while waiting
Expand Down
5 changes: 3 additions & 2 deletions py/selenium/webdriver/remote/webelement.py
Original file line number Diff line number Diff line change
Expand Up @@ -554,9 +554,10 @@ def _execute(self, command, params=None):
Parameters:
----------
command : any
command : any
The name of the command to _execute as a string.
params : dict
params : dict
A dictionary of named Parameters to send with the command.
Returns:
Expand Down
5 changes: 5 additions & 0 deletions py/selenium/webdriver/support/wait.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,14 @@ def __init__(
driver
- Instance of WebDriver (Ie, Firefox, Chrome or Remote) or
a WebElement
timeout
- Number of seconds before timing out
poll_frequency
- Sleep interval between calls
- By default, it is 0.5 second.
ignored_exceptions
- Iterable structure of exception classes ignored during calls.
- By default, it contains NoSuchElementException only.
Expand Down Expand Up @@ -99,6 +102,7 @@ def until(self, method: Callable[[D], Union[Literal[False], T]], message: str =
----------
method: callable(WebDriver)
- A callable object that takes a WebDriver instance as an argument.
message: str
- Optional message for :exc:`TimeoutException`
Expand Down Expand Up @@ -151,6 +155,7 @@ def until_not(self, method: Callable[[D], T], message: str = "") -> Union[T, Lit
----------
method: callable(WebDriver)
- A callable object that takes a WebDriver instance as an argument.
message: str
- Optional message for :exc:`TimeoutException`
Expand Down

0 comments on commit 487b9a2

Please sign in to comment.