Skip to content

Commit 65bb55f

Browse files
authored
[py] Update docstrings style (#16427)
1 parent 8c97d29 commit 65bb55f

File tree

4 files changed

+45
-25
lines changed

4 files changed

+45
-25
lines changed

py/selenium/webdriver/chrome/service.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,17 @@ class Service(service.ChromiumService):
2727
"""A Service class that is responsible for the starting and stopping of
2828
`chromedriver`.
2929
30-
:param executable_path: install path of the chromedriver executable, defaults to `chromedriver`.
31-
:param port: Port for the service to run on, defaults to 0 where the operating system will decide.
32-
:param service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
33-
:param log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
34-
:param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
30+
Args:
31+
executable_path: Install path of the chromedriver executable, defaults
32+
to `chromedriver`.
33+
port: Port for the service to run on, defaults to 0 where the operating
34+
system will decide.
35+
service_args: (Optional) Sequence of args to be passed to the subprocess
36+
when launching the executable.
37+
log_output: (Optional) int representation of STDOUT/DEVNULL, any IO
38+
instance or String path to file.
39+
env: (Optional) Mapping of environment variables for the new process,
40+
defaults to `os.environ`.
3541
"""
3642

3743
def __init__(

py/selenium/webdriver/chromium/service.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,18 @@ class ChromiumService(service.Service):
2727
"""A Service class that is responsible for the starting and stopping the
2828
WebDriver instance of the ChromiumDriver.
2929
30-
:param executable_path: install path of the executable.
31-
:param port: Port for the service to run on, defaults to 0 where the operating system will decide.
32-
:param service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
33-
:param log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
34-
:param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
35-
:param driver_path_env_key: (Optional) Environment variable to use to get the path to the driver executable.
30+
Args:
31+
executable_path: Install path of the executable.
32+
port: Port for the service to run on, defaults to 0 where the operating
33+
system will decide.
34+
service_args: (Optional) Sequence of args to be passed to the subprocess
35+
when launching the executable.
36+
log_output: (Optional) int representation of STDOUT/DEVNULL, any IO
37+
instance or String path to file.
38+
env: (Optional) Mapping of environment variables for the new process,
39+
defaults to `os.environ`.
40+
driver_path_env_key: (Optional) Environment variable to use to get the
41+
path to the driver executable.
3642
"""
3743

3844
def __init__(

py/selenium/webdriver/webkitgtk/service.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,17 @@ class Service(service.Service):
2929
"""A Service class that is responsible for the starting and stopping of
3030
`WebKitWebDriver`.
3131
32-
:param executable_path: install path of the WebKitWebDriver executable, defaults to the first
33-
`WebKitWebDriver` in `$PATH`.
34-
:param port: Port for the service to run on, defaults to 0 where the operating system will decide.
35-
:param service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
36-
:param log_output: (Optional) File path for the file to be opened and passed as the subprocess
37-
stdout/stderr handler.
38-
:param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
32+
Args:
33+
executable_path: Install path of the WebKitWebDriver executable,
34+
defaults to the first `WebKitWebDriver` in `$PATH`.
35+
port: Port for the service to run on, defaults to 0 where the
36+
operating system will decide.
37+
service_args: (Optional) Sequence of args to be passed to the
38+
subprocess when launching the executable.
39+
log_output: (Optional) File path for the file to be opened and passed
40+
as the subprocess stdout/stderr handler.
41+
env: (Optional) Mapping of environment variables for the new process,
42+
defaults to `os.environ`.
3943
"""
4044

4145
def __init__(

py/selenium/webdriver/wpewebkit/service.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@ class Service(service.Service):
2828
"""A Service class that is responsible for the starting and stopping of
2929
`WPEWebDriver`.
3030
31-
:param executable_path: install path of the WPEWebDriver executable, defaults to the first
32-
`WPEWebDriver` in `$PATH`.
33-
:param port: Port for the service to run on, defaults to 0 where the operating system will decide.
34-
:param service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
35-
:param log_output: (Optional) File path for the file to be opened and passed as the subprocess
36-
stdout/stderr handler.
37-
:param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
31+
Args:
32+
executable_path: Install path of the WPEWebDriver executable, defaults
33+
to the first `WPEWebDriver` in `$PATH`.
34+
port: Port for the service to run on, defaults to 0 where the
35+
operating system will decide.
36+
service_args: (Optional) Sequence of args to be passed to the
37+
subprocess when launching the executable.
38+
log_output: (Optional) File path for the file to be opened and passed
39+
as the subprocess stdout/stderr handler.
40+
env: (Optional) Mapping of environment variables for the new process,
41+
defaults to `os.environ`.
3842
"""
3943

4044
def __init__(

0 commit comments

Comments
 (0)