Skip to content

Commit ba0d0e5

Browse files
committed
Update the documentation
1 parent 8f46a62 commit ba0d0e5

File tree

3 files changed

+18
-22
lines changed

3 files changed

+18
-22
lines changed

help_docs/features_list.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- SeleniumBase Docs -->
22

3-
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=Sjzq9kU5kOw"><img src="http://img.youtube.com/vi/Sjzq9kU5kOw/0.jpg" title="SeleniumBase on YouTube" width="285" /></a>
4-
<!-- GitHub Only --><p>(<b><a href="https://www.youtube.com/watch?v=Sjzq9kU5kOw">Watch the tutorial on YouTube</a></b>)</p>
3+
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=EablmOazy-k"><img src="http://img.youtube.com/vi/EablmOazy-k/0.jpg" title="SeleniumBase on YouTube" width="285" /></a>
4+
<!-- GitHub Only --><p>(<b><a href="https://www.youtube.com/watch?v=EablmOazy-k">Watch the new tutorial on YouTube</a></b>)</p>
55

66
<a id="feature_list"></a>
77

@@ -53,6 +53,8 @@
5353
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=yEQeAU_mrg0"><img src="http://img.youtube.com/vi/yEQeAU_mrg0/0.jpg" title="SeleniumBase on YouTube" width="285" /></a>
5454
<!-- GitHub Only --><p>(<b><a href="https://www.youtube.com/watch?v=yEQeAU_mrg0">Have fun with test automation!</a></b>)</p>
5555

56+
(<b><a href="https://www.youtube.com/watch?v=Sjzq9kU5kOw">Watch the old tutorial on YouTube</a></b>)
57+
5658
<p align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_10.png" alt="SeleniumBase" title="SeleniumBase" width="200"></a></p>
5759

5860
[<img src="https://seleniumbase.github.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="200">](https://seleniumbase.io/)

help_docs/method_summary.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -635,11 +635,9 @@ self.add_slide(
635635
content=None, image=None, code=None, iframe=None,
636636
content2=None, notes=None, transition=None, name=None)
637637

638-
self.save_presentation(
639-
name=None, filename=None, show_notes=False, interval=0)
638+
self.save_presentation(name=None, filename=None, show_notes=False, interval=0)
640639

641-
self.begin_presentation(
642-
name=None, filename=None, show_notes=False, interval=0)
640+
self.begin_presentation(name=None, filename=None, show_notes=False, interval=0)
643641

644642
############
645643

@@ -692,8 +690,7 @@ self.create_introjs_tour(name=None)
692690

693691
self.set_introjs_colors(theme_color=None, hover_color=None)
694692

695-
self.add_tour_step(
696-
message, selector=None, name=None, title=None, theme=None, alignment=None)
693+
self.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
697694

698695
self.play_tour(name=None, interval=0)
699696
# Duplicates:
@@ -727,8 +724,7 @@ self.post_success_message(message, duration=None, pause=True)
727724

728725
self.post_error_message(message, duration=None, pause=True)
729726

730-
self.set_messenger_theme(
731-
theme="default", location="default", max_messages="default")
727+
self.set_messenger_theme(theme="default", location="default", max_messages="default")
732728

733729
############
734730

@@ -874,25 +870,21 @@ self.quit_extra_driver(driver=None)
874870

875871
############
876872

877-
self.check_window(
878-
name="default", level=0, baseline=False, check_domain=True, full_diff=False)
873+
self.check_window(name="default", level=0, baseline=False, check_domain=True, full_diff=False)
879874

880875
############
881876

882-
self.deferred_assert_element(
883-
selector, by="css selector", timeout=None, fs=False)
877+
self.deferred_assert_element(selector, by="css selector", timeout=None, fs=False)
884878
# Duplicates:
885879
# self.delayed_assert_element(
886880
# selector, by="css selector", timeout=None, fs=False)
887881

888-
self.deferred_assert_element_present(
889-
selector, by="css selector", timeout=None, fs=False)
882+
self.deferred_assert_element_present(selector, by="css selector", timeout=None, fs=False)
890883
# Duplicates:
891884
# self.delayed_assert_element_present(
892885
# selector, by="css selector", timeout=None, fs=False)
893886

894-
self.deferred_assert_text(
895-
text, selector="html", by="css selector", timeout=None, fs=False)
887+
self.deferred_assert_text(text, selector="html", by="css selector", timeout=None, fs=False)
896888
# Duplicates:
897889
# self.delayed_assert_text(
898890
# text, selector="html", by="css selector", timeout=None, fs=False)

help_docs/recorder_mode.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99

1010
<img src="https://seleniumbase.github.io/cdn/img/sb_recorder_notification.png" title="SeleniumBase" width="380">
1111

12-
⏺️ To make a new recording with Recorder Mode, use ``sbase mkrec``, ``sbase codegen``, or ``sbase record``):
12+
ℹ️ Recorder Mode can be activated from the command-line interface, or from the Recorder Desktop App.
13+
14+
⏺️ To make a new recording from the command-line interface, use ``sbase mkrec``, ``sbase codegen``, or ``sbase record``):
1315

1416
```bash
1517
sbase mkrec TEST_NAME.py --url=URL
@@ -46,20 +48,20 @@ pytest new_test.py --rec -q -s --url=wikipedia.org
4648
*** RECORDING COPIED to: new_test.py
4749
```
4850
49-
🔴 You can also activate Recorder Mode from the Desktop App:
51+
🔴 You can also activate Recorder Mode from the Recorder Desktop App:
5052
5153
```bash
5254
sbase recorder
5355
* Starting the SeleniumBase Recorder Desktop App...
5456
```
5557
56-
<img src="https://seleniumbase.github.io/cdn/img/recorder_desktop.png" title="SeleniumBase" width="340">
58+
<img src="https://seleniumbase.github.io/cdn/img/recorder_desktop_2.png" title="SeleniumBase" width="340">
5759
5860
⏺️ While a recording is in progress, you can press the ``[ESC]`` key to pause the Recorder. To resume the recording, you can hit the ``[~`]`` key, which is located directly below the ``[ESC]`` key on most keyboards.
5961
6062
⏺️ From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the ``[^]-key (SHIFT+6)``: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the ``[&]-key (SHIFT+7)``: The border will become teal, and you'll be able to click on elements for asserting text from your test.
6163
62-
While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To add an assertion for buttons without triggering default "click" behavior, mouse-down on the button and then mouse-up somewhere else. (This prevents a detected click while still recording the assert.) To return back to the original Recorder Mode, press any key other than ``[SHIFT]`` or ``[BACKSPACE]`` (Eg: Press ``[CONTROL]``, etc.). Press ``[ESC]`` once to leave the Assertion Modes, but it'll stop the Recorder if you press it again.
64+
⏺️ While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To add an assertion for buttons without triggering default "click" behavior, mouse-down on the button and then mouse-up somewhere else. (This prevents a detected click while still recording the assert.) To return back to the original Recorder Mode, press any key other than ``[SHIFT]`` or ``[BACKSPACE]`` (Eg: Press ``[CONTROL]``, etc.). Press ``[ESC]`` once to leave the Assertion Modes, but it'll stop the Recorder if you press it again.
6365
6466
⏺️ For extra flexibility, the ``sbase mkrec`` command can be split into four separate commands:
6567

0 commit comments

Comments
 (0)