Skip to content

Commit 2d5b5fa

Browse files
committed
DOC: Update docstrings for properties.
1 parent 0f676c2 commit 2d5b5fa

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

botcity/web/bot.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ def driver_path(self, driver_path):
8888

8989
@property
9090
def browser(self):
91+
"""
92+
The web browser to be used.
93+
94+
Returns:
95+
browser (Browser): The web browser to be used.
96+
"""
9197
return self._browser
9298

9399
@browser.setter
@@ -102,6 +108,12 @@ def browser(self, browser):
102108

103109
@property
104110
def options(self):
111+
"""
112+
The options to be passed down to the WebDriver when starting the browser.
113+
114+
Returns:
115+
options (Options): The browser specific options to be used.
116+
"""
105117
return self._options
106118

107119
@options.setter
@@ -131,6 +143,12 @@ def download_folder_path(self, folder_path):
131143

132144
@property
133145
def headless(self):
146+
"""
147+
Controls whether or not the bot will run headless.
148+
149+
Returns:
150+
headless (bool): Whether or not to run the browser on headless mode.
151+
"""
134152
return self._headless
135153

136154
@headless.setter

0 commit comments

Comments
 (0)