Skip to content

Commit 3ddf107

Browse files
committed
refactor: update argument documentation format in Options and WebDriver classes webkitgtk
1 parent 9b80833 commit 3ddf107

File tree

4 files changed

+20
-15
lines changed

4 files changed

+20
-15
lines changed

py/selenium/webdriver/webkitgtk/options.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,35 @@ def __init__(self) -> None:
2929

3030
@property
3131
def binary_location(self) -> str:
32-
""":Returns: The location of the browser binary otherwise an empty
33-
string."""
32+
"""
33+
Returns:
34+
The location of the browser binary, otherwise an empty string.
35+
"""
3436
return self._binary_location
3537

3638
@binary_location.setter
3739
def binary_location(self, value: str) -> None:
3840
"""Allows you to set the browser binary to launch.
3941
40-
:Args:
41-
- value : path to the browser binary
42+
Args:
43+
value: path to the browser binary
4244
"""
4345
self._binary_location = value
4446

4547
@property
4648
def overlay_scrollbars_enabled(self):
47-
""":Returns: Whether overlay scrollbars should be enabled."""
49+
"""
50+
Returns:
51+
Whether overlay scrollbars should be enabled.
52+
"""
4853
return self._overlay_scrollbars_enabled
4954

5055
@overlay_scrollbars_enabled.setter
5156
def overlay_scrollbars_enabled(self, value) -> None:
5257
"""Allows you to enable or disable overlay scrollbars.
5358
54-
:Args:
55-
- value : True or False
59+
Args:
60+
value: True or False
5661
"""
5762
self._overlay_scrollbars_enabled = value
5863

py/selenium/webdriver/webkitgtk/webdriver.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ def __init__(
3636
3737
Starts the service and then creates new instance of WebKitGTK Driver.
3838
39-
:Args:
40-
- options : an instance of WebKitGTKOptions
41-
- service : Service object for handling the browser driver if you need to pass extra details
39+
Args:
40+
options: an instance of WebKitGTKOptions
41+
service: Service object for handling the browser driver if you need to pass extra details
4242
"""
4343

4444
options = options if options else Options()

py/selenium/webdriver/wpewebkit/options.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ def binary_location(self) -> str:
3737
def binary_location(self, value: str) -> None:
3838
"""Allows you to set the browser binary to launch.
3939
40-
:Args:
41-
- value : path to the browser binary
40+
Args:
41+
value: path to the browser binary
4242
"""
4343
if not isinstance(value, str):
4444
raise TypeError(self.BINARY_LOCATION_ERROR)

py/selenium/webdriver/wpewebkit/webdriver.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ def __init__(
3636
3737
Starts the service and then creates new instance of WPEWebKit Driver.
3838
39-
:Args:
40-
- options : an instance of ``WPEWebKitOptions``
41-
- service : Service object for handling the browser driver if you need to pass extra details
39+
Args:
40+
options: an instance of ``WPEWebKitOptions``
41+
service: Service object for handling the browser driver if you need to pass extra details
4242
"""
4343

4444
options = options if options else Options()

0 commit comments

Comments
 (0)