Skip to content

Commit c5e43af

Browse files
committed
Update documentation
1 parent 353dc29 commit c5e43af

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ class CoffeeCartTest(BaseCase):
136136

137137
<p>💡 With raw Selenium, commands that use selectors need to specify the type of selector (eg. <code>"css selector", "button#myButton"</code>). With SeleniumBase, there's auto-detection between CSS Selectors and XPath, which means you don't need to specify the type of selector in your commands (<i>but optionally you could</i>).</p>
138138

139-
<p>💡 SeleniumBase methods often perform multiple actions in a single method call. For example, <code>self.type(selector,text)</code> does the following:<br />1. Waits for the element to be visible.<br />2. Waits for the element to be interactive.<br />3. Clears the text field.<br />4. Types in the new text.<br />5. Presses Enter/Submit if the text ends in "\n".<br />With raw Selenium, those actions require multiple method calls.</p>
139+
<p>💡 SeleniumBase methods often perform multiple actions in a single method call. For example, <code>self.type(selector,text)</code> does the following:<br />1. Waits for the element to be visible.<br />2. Waits for the element to be interactive.<br />3. Clears the text field.<br />4. Types in the new text.<br />5. Presses Enter/Submit if the text ends in <code>"\n"</code>.<br />With raw Selenium, those actions require multiple method calls.</p>
140140

141141
<p>💡 SeleniumBase uses default timeout values when not set:<br />
142142
✅<code>self.click("button")</code><br />
@@ -659,8 +659,8 @@ pytest test_coffee_cart.py --trace
659659
--incognito # (Enable Chrome's Incognito mode.)
660660
--guest # (Enable Chrome's Guest mode.)
661661
--devtools # (Open Chrome's DevTools when the browser opens.)
662-
--reuse-session | --rs # (Reuse browser session for all tests.)
663-
--reuse-class-session | --rcs # (Reuse session for tests in class.)
662+
--rs | --reuse-session # (Reuse browser session for all tests.)
663+
--rcs | --reuse-class-session # (Reuse session for tests in class.)
664664
--crumbs # (Delete all cookies between tests reusing a session.)
665665
--disable-beforeunload # (Disable the "beforeunload" event on Chrome.)
666666
--window-size=WIDTH,HEIGHT # (Set the browser's starting window size.)

examples/migration/raw_selenium/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ With a complete test automation framework built, most of the hard work is alread
4747

4848
<p>💡 With raw Selenium, commands that use selectors need to specify the type of selector (eg. <code>"css selector", "button#myButton"</code>). With SeleniumBase, there's auto-detection between CSS Selectors and XPath, which means you don't need to specify the type of selector in your commands (<i>but optionally you could</i>).</p>
4949

50-
<p>💡 SeleniumBase methods often perform multiple actions in a single method call. For example, <code>self.type(selector,text)</code> does the following:<br />1. Waits for the element to be visible.<br />2. Waits for the element to be interactive.<br />3. Clears the text field.<br />4. Types in the new text.<br />5. Presses Enter/Submit if the text ends in "\n".<br />With raw Selenium, those actions require multiple method calls.</p>
50+
<p>💡 SeleniumBase methods often perform multiple actions in a single method call. For example, <code>self.type(selector,text)</code> does the following:<br />1. Waits for the element to be visible.<br />2. Waits for the element to be interactive.<br />3. Clears the text field.<br />4. Types in the new text.<br />5. Presses Enter/Submit if the text ends in <code>"\n"</code>.<br />With raw Selenium, those actions require multiple method calls.</p>
5151

5252
<p>💡 SeleniumBase uses default timeout values when not set, which means that methods automatically wait for elements to appear (<i>up to the timeout limit</i>) before failing:<br />✅<code>self.click("button")</code><br />With raw Selenium, methods would fail instantly (<i>by default</i>) if an element needed more time to load:<br />❌<code>self.driver.find_element(by="css selector", value="button").click()</code><br />(Reliable code is better than unreliable code.)</p>
5353

@@ -64,4 +64,4 @@ With a complete test automation framework built, most of the hard work is alread
6464

6565
--------
6666

67-
[<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase)
67+
[<img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase)

help_docs/customizing_test_runs.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ pytest test_swag_labs.py --mobile
7373
# Run mobile tests specifying CSS Width, CSS Height, and Pixel-Ratio
7474
pytest test_swag_labs.py --mobile --metrics="360,640,2"
7575

76+
# Run a test with an option to evade bot-detection services
77+
pytest verify_undetected.py --uc
78+
7679
# Run tests while changing SeleniumBase default settings
7780
pytest my_first_test.py --settings-file=custom_settings.py
7881
```
@@ -177,8 +180,8 @@ pytest my_first_test.py --settings-file=custom_settings.py
177180
--incognito # (Enable Chrome's Incognito mode.)
178181
--guest # (Enable Chrome's Guest mode.)
179182
--devtools # (Open Chrome's DevTools when the browser opens.)
180-
--reuse-session | --rs # (Reuse browser session for all tests.)
181-
--reuse-class-session | --rcs # (Reuse session for tests in class.)
183+
--rs | --reuse-session # (Reuse browser session for all tests.)
184+
--rcs | --reuse-class-session # (Reuse session for tests in class.)
182185
--crumbs # (Delete all cookies between tests reusing a session.)
183186
--disable-beforeunload # (Disable the "beforeunload" event on Chrome.)
184187
--window-size=WIDTH,HEIGHT # (Set the browser's starting window size.)

0 commit comments

Comments
 (0)