Skip to content

Commit a0bd54f

Browse files
committed
Update comments
1 parent 8daf349 commit a0bd54f

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

seleniumbase/fixtures/base_case.py

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -833,9 +833,9 @@ def click_chain(
833833
"""This method clicks on a list of elements in succession.
834834
@Params
835835
selectors_list - The list of selectors to click on.
836-
by - The type of selector to search by (Default: CSS_Selector).
836+
by - The type of selector to search by (Default: "css selector").
837837
timeout - How long to wait for the selector to be visible.
838-
spacing - The amount of time to wait between clicks (in seconds). """
838+
spacing - The amount of time to wait between clicks (in seconds)."""
839839
self.__check_scope()
840840
if not timeout:
841841
timeout = settings.SMALL_TIMEOUT
@@ -857,11 +857,11 @@ def update_text(
857857
* Types in the new text.
858858
* Hits Enter/Submit (if the text ends in "\n").
859859
@Params
860-
selector - the selector of the text field
861-
text - the new text to type into the text field
862-
by - the type of selector to search by (Default: CSS Selector)
863-
timeout - how long to wait for the selector to be visible
864-
retry - if True, use JS if the Selenium text update fails """
860+
selector - The selector of the text field.
861+
text - The new text to type into the text field.
862+
by - The type of selector to search by. (Default: "css selector")
863+
timeout - How long to wait for the selector to be visible.
864+
retry - If True, use JS if the Selenium text update fails."""
865865
self.__check_scope()
866866
if not timeout:
867867
timeout = settings.LARGE_TIMEOUT
@@ -1039,11 +1039,11 @@ def type(
10391039
* Types in the new text.
10401040
* Hits Enter/Submit (if the text ends in "\n").
10411041
@Params
1042-
selector - the selector of the text field
1043-
text - the new text to type into the text field
1044-
by - the type of selector to search by (Default: CSS Selector)
1045-
timeout - how long to wait for the selector to be visible
1046-
retry - if True, use JS if the Selenium text update fails
1042+
selector - The selector of the text field.
1043+
text - The new text to type into the text field.
1044+
by - The type of selector to search by. (Default: "css selector")
1045+
timeout - How long to wait for the selector to be visible.
1046+
retry - If True, use JS if the Selenium text update fails.
10471047
DO NOT confuse self.type() with Python type()! They are different!
10481048
"""
10491049
self.__check_scope()
@@ -1085,9 +1085,9 @@ def clear(self, selector, by="css selector", timeout=None):
10851085
In case websites trigger an autofill after clearing a field,
10861086
add backspaces to make sure autofill doesn't undo the clear.
10871087
@Params
1088-
selector - the selector of the text field
1089-
by - the type of selector to search by (Default: CSS Selector)
1090-
timeout - how long to wait for the selector to be visible """
1088+
selector - The selector of the text field.
1089+
by - The type of selector to search by. (Default: "css selector")
1090+
timeout - How long to wait for the selector to be visible."""
10911091
self.__check_scope()
10921092
if not timeout:
10931093
timeout = settings.LARGE_TIMEOUT
@@ -6625,7 +6625,9 @@ def append_data_to_file(self, data, file_name, destination_folder=None):
66256625
def get_file_data(self, file_name, folder=None):
66266626
"""Gets the data from the file specified.
66276627
If no folder is specified, the default one is used.
6628-
(The default folder = "./downloaded_files")
6628+
The default folder = "./downloaded_files"
6629+
For the "latest_logs/" test data folders, use:
6630+
self.data_path OR self.data_abspath
66296631
Use "." as the folder for the current directory."""
66306632
if not folder:
66316633
folder = constants.Files.DOWNLOADS_FOLDER
@@ -8337,7 +8339,7 @@ def post_message_and_highlight(self, message, selector, by="css selector"):
83378339
Arguments:
83388340
message: The message to display.
83398341
selector: The selector of the Element to highlight.
8340-
by: The type of selector to search by. (Default: CSS Selector)"""
8342+
by: The type of selector to search by. (Default: "css selector")"""
83418343
self.__check_scope()
83428344
self.__highlight_with_assert_success(message, selector, by=by)
83438345

0 commit comments

Comments
 (0)