Skip to content

Commit 7aaa8af

Browse files
committed
Update the docs
1 parent de6ae6e commit 7aaa8af

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,7 +1125,7 @@ self.driver.find_elements("partial link text", "GitHub")
11251125
pytest --reruns=1 --reruns-delay=1
11261126
```
11271127
1128-
<p>Additionally, you can use the <code>@retry_on_exception()</code> decorator to specifically retry failing methods. (First import: <code>from seleniumbase import decorators</code>) To learn more about SeleniumBase decorators, [click here](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common).</p>
1128+
<p>You can use the <code>@retry_on_exception()</code> decorator to retry failing methods. (First import: <code>from seleniumbase import decorators</code>). To learn more about SeleniumBase decorators, <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common">click here</a>.</p>
11291129
11301130
11311131
<h3><img src="https://seleniumbase.github.io/img/green_logo2.png" title="SeleniumBase" width="32" /> Wrap-Up</h3>
@@ -1138,7 +1138,7 @@ pytest --reruns=1 --reruns-delay=1
11381138
</p>
11391139
11401140
<p>
1141-
<div><b>If you like us, give us a star!</b></div>
1141+
<div><b>If you like SeleniumBase, star us! ⭐</b></div>
11421142
<div><a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=19A57B" title="Stargazers" /></a></div>
11431143
</p>
11441144
<p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>

help_docs/features_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<a id="feature_list"></a>
55

6-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Features: 🎯
6+
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Features: 🥂
77

88
* A powerful Python framework for browser automation and E2E UI testing.
99
* Includes [Recorder Mode](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md) for instantly generating browser tests in Python.

help_docs/how_it_works.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
<a id="how_seleniumbase_works"></a>
44

5-
At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests (using [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/)), and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
5+
👁️🔎 At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests (using [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/)), and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
66

7-
(NOTE: pytest uses a feature called test discovery to automatically find and run Python methods that start with ``test_`` from the file that you specified on the command line.)
7+
👁️🔎 ``pytest`` uses a feature called test discovery to automatically find and run Python methods that start with ``test_`` when those methods are located in Python files that start with ``test_`` or end with ``_test.py``.
88

9-
The most common way of using SeleniumBase is by inheriting BaseCase:
9+
👁️🔎 The most common way of using **SeleniumBase** is by inheriting ``BaseCase``:
1010

1111
```python
1212
from seleniumbase import BaseCase
1313
```
1414

15-
Then have your test classes inherit BaseCase:
15+
Then have your test classes inherit ``BaseCase``:
1616

1717
```python
1818
class MyTestClass(BaseCase):
@@ -40,7 +40,7 @@ class TestMFALogin(BaseCase):
4040

4141
(See the example, [test_mfa_login.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_mfa_login.py), for reference.)
4242

43-
The most common way of running SeleniumBase tests is with ``pytest``:
43+
👁️🔎 Here are some examples of running tests with ``pytest``:
4444

4545
```bash
4646
pytest --headless --rs --dashboard --html=report.html -v -n=4
@@ -50,7 +50,7 @@ pytest offline_examples/
5050
pytest -k agent
5151
```
5252

53-
(See <a href="https://seleniumbase.io/help_docs/syntax_formats/">SyntaxFormats</a> for more ways of using SeleniumBase.)
53+
(See <a href="https://seleniumbase.io/help_docs/syntax_formats/">SyntaxFormats</a> for more ways of using <b>SeleniumBase</b>.)
5454

5555
--------
5656

help_docs/thank_you.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

3-
### Thank you for flying with SeleniumBase!
3+
### Thank you for flying with SeleniumBase! 🛸
44

55
--------
66

0 commit comments

Comments
 (0)