@@ -757,8 +757,8 @@ def create_tour(self, name=None, theme=None):
757
757
""" Creates a tour for a website. By default, the Shepherd Javascript
758
758
Library is used with the Shepherd "Light" / "Arrows" theme.
759
759
@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.
762
762
theme - Sets the default theme for the tour.
763
763
Choose from "light"/"arrows", "dark", "default", "square",
764
764
and "square-dark". ("arrows" is used if None is selected.)
@@ -793,8 +793,8 @@ def create_tour(self, name=None, theme=None):
793
793
def create_shepherd_tour (self , name = None , theme = None ):
794
794
""" Creates a Shepherd JS website tour.
795
795
@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.
798
798
theme - Sets the default theme for the tour.
799
799
Choose from "light"/"arrows", "dark", "default", "square",
800
800
and "square-dark". ("light" is used if None is selected.)
@@ -854,8 +854,8 @@ def create_shepherd_tour(self, name=None, theme=None):
854
854
def create_bootstrap_tour (self , name = None ):
855
855
""" Creates a Bootstrap tour for a website.
856
856
@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.
859
859
"""
860
860
if not name :
861
861
name = "default"
@@ -874,8 +874,8 @@ def create_bootstrap_tour(self, name=None):
874
874
def create_hopscotch_tour (self , name = None ):
875
875
""" Creates an Hopscotch tour for a website.
876
876
@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.
879
879
"""
880
880
if not name :
881
881
name = "default"
@@ -894,8 +894,8 @@ def create_hopscotch_tour(self, name=None):
894
894
def create_introjs_tour (self , name = None ):
895
895
""" Creates an IntroJS tour for a website.
896
896
@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.
899
899
"""
900
900
if not name :
901
901
name = "default"
@@ -918,8 +918,8 @@ def add_tour_step(self, message, selector=None, name=None,
918
918
@Params
919
919
message - The message to display.
920
920
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.
923
923
title - Additional header text that appears above the message.
924
924
theme - (NON-Bootstrap Tours ONLY) The styling of the tour step.
925
925
Choose from "light"/"arrows", "dark", "default", "square",
@@ -980,8 +980,8 @@ def __add_shepherd_tour_step(self, message, selector=None, name=None,
980
980
@Params
981
981
message - The message to display.
982
982
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.
985
985
title - Additional header text that appears above the message.
986
986
theme - (NON-Bootstrap Tours ONLY) The styling of the tour step.
987
987
Choose from "light"/"arrows", "dark", "default", "square",
@@ -1034,8 +1034,8 @@ def __add_bootstrap_tour_step(self, message, selector=None, name=None,
1034
1034
@Params
1035
1035
message - The message to display.
1036
1036
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.
1039
1039
title - Additional header text that appears above the message.
1040
1040
alignment - Choose from "top", "bottom", "left", and "right".
1041
1041
("top" is the default alignment).
@@ -1070,8 +1070,8 @@ def __add_hopscotch_tour_step(self, message, selector=None, name=None,
1070
1070
@Params
1071
1071
message - The message to display.
1072
1072
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.
1075
1075
title - Additional header text that appears above the message.
1076
1076
alignment - Choose from "top", "bottom", "left", and "right".
1077
1077
("bottom" is the default alignment).
@@ -1102,8 +1102,8 @@ def __add_introjs_tour_step(self, message, selector=None, name=None,
1102
1102
@Params
1103
1103
message - The message to display.
1104
1104
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.
1107
1107
title - Additional header text that appears above the message.
1108
1108
alignment - Choose from "top", "bottom", "left", and "right".
1109
1109
("top" is the default alignment).
@@ -1128,8 +1128,8 @@ def __add_introjs_tour_step(self, message, selector=None, name=None,
1128
1128
def play_tour (self , name = None , interval = 0 ):
1129
1129
""" Plays a tour on the current website.
1130
1130
@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 .
1133
1133
interval - The delay time between autoplaying tour steps.
1134
1134
If set to 0 (default), the tour is fully manual control.
1135
1135
"""
@@ -1167,8 +1167,8 @@ def export_tour(self, name=None, filename="my_tour.js"):
1167
1167
You'll be able to copy the tour directly into the Console of
1168
1168
any web browser to play the tour outside of SeleniumBase runs.
1169
1169
@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 .
1172
1172
filename - The name of the javascript file that you wish to
1173
1173
save the tour to. """
1174
1174
tour_helper .export_tour (self ._tour_steps , name = name , filename = filename )
0 commit comments