From caec440bef5f368e6c631871adeb48b2ff33701e Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Fri, 5 Feb 2021 23:26:25 -0500 Subject: [PATCH] Update the docs --- README.md | 17 ++++++++--------- examples/ReadMe.md | 2 +- seleniumbase/console_scripts/run.py | 2 +- seleniumbase/plugins/pytest_plugin.py | 2 +- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ff6c2ef6..3e23e9e6 100755 --- a/README.md +++ b/README.md @@ -50,20 +50,19 @@ Tests are run with "pytest". Browsers are controlled by WebDriver. 🛂 MasterQA

-✅ Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for Web-UI testing.
-✅ Expands pytest [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
-✅ Includes [scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md) for driver management.
-✅ Includes tools for [dashboards & reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
+✅ Get set up in minutes. Deploy anywhere.
+✅ Build Web-UI tests with a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md).
+✅ Generate [test reports and dashboards](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
-------- -

(Example: test_swag_labs.py in Demo Mode.)

+

(Example: my_first_test.py in Demo Mode.)

```bash -pytest test_swag_labs.py --demo +pytest my_first_test.py --demo ``` -

SeleniumBase Demo Mode

+

SeleniumBase Demo Mode

Python Setup:

@@ -181,7 +180,7 @@ pytest test_swag_labs.py pytest my_first_test.py --demo ``` - + Here's the code for [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py): @@ -382,7 +381,7 @@ The code above will leave your browser window open in case there's a failure. (i --incognito # (Enable Chrome's Incognito mode.) --guest # (Enable Chrome's Guest mode.) --devtools # (Open Chrome's DevTools when the browser opens.) ---reuse-session # (Reuse the browser session between tests.) +--reuse-session | --rs # (Reuse browser session between tests.) --crumbs # (Delete all cookies between tests reusing a session.) --maximize-window # (Start tests with the web browser window maximized.) --save-screenshot # (Save a screenshot at the end of each test.) diff --git a/examples/ReadMe.md b/examples/ReadMe.md index 412c16e7..86583b2f 100755 --- a/examples/ReadMe.md +++ b/examples/ReadMe.md @@ -33,7 +33,7 @@ Run an example test in Demo Mode: (highlight assertions) pytest my_first_test.py --demo ``` -
+
Run a different example in Demo Mode: diff --git a/seleniumbase/console_scripts/run.py b/seleniumbase/console_scripts/run.py index 4d27d638..46e75a01 100644 --- a/seleniumbase/console_scripts/run.py +++ b/seleniumbase/console_scripts/run.py @@ -575,7 +575,7 @@ def show_options(): print('--headless (Run tests headlessly. Default mode on Linux OS.)') print('--demo (Slow down and visually see test actions as they occur.)') print('--slow (Slow down the automation. Faster than using Demo Mode.)') - print('--reuse-session / --rs (Reuse the browser session between tests.)') + print('--reuse-session / --rs (Reuse browser session between tests.)') print('--crumbs (Delete all cookies between tests reusing a session.)') print('--maximize (Start tests with the web browser window maximized.)') print('--dashboard (Enable the SeleniumBase Dashboard at dashboard.html)') diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py index cb699074..84352448 100644 --- a/seleniumbase/plugins/pytest_plugin.py +++ b/seleniumbase/plugins/pytest_plugin.py @@ -67,7 +67,7 @@ def pytest_addoption(parser): --incognito (Enable Chrome's Incognito mode.) --guest (Enable Chrome's Guest mode.) --devtools (Open Chrome's DevTools when the browser opens.) - --reuse-session / --rs (Reuse the browser session between tests.) + --reuse-session | --rs (Reuse browser session between tests.) --crumbs (Delete all cookies between tests reusing a session.) --maximize (Start tests with the web browser window maximized.) --save-screenshot (Save a screenshot at the end of each test.)