Skip to content

Commit 752e49f

Browse files
committed
Update comments
1 parent 0e23e9e commit 752e49f

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

seleniumbase/fixtures/base_case.py

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -757,8 +757,8 @@ def create_tour(self, name=None, theme=None):
757757
""" Creates a tour for a website. By default, the Shepherd Javascript
758758
Library is used with the Shepherd "Light" / "Arrows" theme.
759759
@Params
760-
name - If creating multiple tours, use this to select the
761-
tour you wish to add steps to.
760+
name - If creating multiple tours at the same time,
761+
use this to select the tour you wish to add steps to.
762762
theme - Sets the default theme for the tour.
763763
Choose from "light"/"arrows", "dark", "default", "square",
764764
and "square-dark". ("arrows" is used if None is selected.)
@@ -793,8 +793,8 @@ def create_tour(self, name=None, theme=None):
793793
def create_shepherd_tour(self, name=None, theme=None):
794794
""" Creates a Shepherd JS website tour.
795795
@Params
796-
name - If creating multiple tours, use this to select the
797-
tour you wish to add steps to.
796+
name - If creating multiple tours at the same time,
797+
use this to select the tour you wish to add steps to.
798798
theme - Sets the default theme for the tour.
799799
Choose from "light"/"arrows", "dark", "default", "square",
800800
and "square-dark". ("light" is used if None is selected.)
@@ -854,8 +854,8 @@ def create_shepherd_tour(self, name=None, theme=None):
854854
def create_bootstrap_tour(self, name=None):
855855
""" Creates a Bootstrap tour for a website.
856856
@Params
857-
name - If creating multiple tours, use this to select the
858-
tour you wish to add steps to.
857+
name - If creating multiple tours at the same time,
858+
use this to select the tour you wish to add steps to.
859859
"""
860860
if not name:
861861
name = "default"
@@ -874,8 +874,8 @@ def create_bootstrap_tour(self, name=None):
874874
def create_hopscotch_tour(self, name=None):
875875
""" Creates an Hopscotch tour for a website.
876876
@Params
877-
name - If creating multiple tours, use this to select the
878-
tour you wish to add steps to.
877+
name - If creating multiple tours at the same time,
878+
use this to select the tour you wish to add steps to.
879879
"""
880880
if not name:
881881
name = "default"
@@ -894,8 +894,8 @@ def create_hopscotch_tour(self, name=None):
894894
def create_introjs_tour(self, name=None):
895895
""" Creates an IntroJS tour for a website.
896896
@Params
897-
name - If creating multiple tours, use this to select the
898-
tour you wish to add steps to.
897+
name - If creating multiple tours at the same time,
898+
use this to select the tour you wish to add steps to.
899899
"""
900900
if not name:
901901
name = "default"
@@ -918,8 +918,8 @@ def add_tour_step(self, message, selector=None, name=None,
918918
@Params
919919
message - The message to display.
920920
selector - The CSS Selector of the Element to attach to.
921-
name - If creating multiple tours, use this to select the
922-
tour you wish to add steps to.
921+
name - If creating multiple tours at the same time,
922+
use this to select the tour you wish to add steps to.
923923
title - Additional header text that appears above the message.
924924
theme - (NON-Bootstrap Tours ONLY) The styling of the tour step.
925925
Choose from "light"/"arrows", "dark", "default", "square",
@@ -980,8 +980,8 @@ def __add_shepherd_tour_step(self, message, selector=None, name=None,
980980
@Params
981981
message - The message to display.
982982
selector - The CSS Selector of the Element to attach to.
983-
name - If creating multiple tours, use this to select the
984-
tour you wish to add steps to.
983+
name - If creating multiple tours at the same time,
984+
use this to select the tour you wish to add steps to.
985985
title - Additional header text that appears above the message.
986986
theme - (NON-Bootstrap Tours ONLY) The styling of the tour step.
987987
Choose from "light"/"arrows", "dark", "default", "square",
@@ -1034,8 +1034,8 @@ def __add_bootstrap_tour_step(self, message, selector=None, name=None,
10341034
@Params
10351035
message - The message to display.
10361036
selector - The CSS Selector of the Element to attach to.
1037-
name - If creating multiple tours, use this to select the
1038-
tour you wish to add steps to.
1037+
name - If creating multiple tours at the same time,
1038+
use this to select the tour you wish to add steps to.
10391039
title - Additional header text that appears above the message.
10401040
alignment - Choose from "top", "bottom", "left", and "right".
10411041
("top" is the default alignment).
@@ -1070,8 +1070,8 @@ def __add_hopscotch_tour_step(self, message, selector=None, name=None,
10701070
@Params
10711071
message - The message to display.
10721072
selector - The CSS Selector of the Element to attach to.
1073-
name - If creating multiple tours, use this to select the
1074-
tour you wish to add steps to.
1073+
name - If creating multiple tours at the same time,
1074+
use this to select the tour you wish to add steps to.
10751075
title - Additional header text that appears above the message.
10761076
alignment - Choose from "top", "bottom", "left", and "right".
10771077
("bottom" is the default alignment).
@@ -1102,8 +1102,8 @@ def __add_introjs_tour_step(self, message, selector=None, name=None,
11021102
@Params
11031103
message - The message to display.
11041104
selector - The CSS Selector of the Element to attach to.
1105-
name - If creating multiple tours, use this to select the
1106-
tour you wish to add steps to.
1105+
name - If creating multiple tours at the same time,
1106+
use this to select the tour you wish to add steps to.
11071107
title - Additional header text that appears above the message.
11081108
alignment - Choose from "top", "bottom", "left", and "right".
11091109
("top" is the default alignment).
@@ -1128,8 +1128,8 @@ def __add_introjs_tour_step(self, message, selector=None, name=None,
11281128
def play_tour(self, name=None, interval=0):
11291129
""" Plays a tour on the current website.
11301130
@Params
1131-
name - If creating multiple tours, use this to select the
1132-
tour you wish to play.
1131+
name - If creating multiple tours at the same time,
1132+
use this to select the tour you wish to add steps to.
11331133
interval - The delay time between autoplaying tour steps.
11341134
If set to 0 (default), the tour is fully manual control.
11351135
"""
@@ -1167,8 +1167,8 @@ def export_tour(self, name=None, filename="my_tour.js"):
11671167
You'll be able to copy the tour directly into the Console of
11681168
any web browser to play the tour outside of SeleniumBase runs.
11691169
@Params
1170-
name - If creating multiple tours, use this to select the
1171-
tour you wish to play.
1170+
name - If creating multiple tours at the same time,
1171+
use this to select the tour you wish to add steps to.
11721172
filename - The name of the javascript file that you wish to
11731173
save the tour to. """
11741174
tour_helper.export_tour(self._tour_steps, name=name, filename=filename)

0 commit comments

Comments
 (0)