From 293bf8879c8bb33bee0db23bb36904bfed06a4b9 Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Thu, 12 Nov 2020 00:57:20 -0500 Subject: [PATCH] Update the docs --- README.md | 8 ++++---- examples/ReadMe.md | 10 +++++----- examples/example_logs/ReadMe.md | 2 +- examples/swag_labs_suite.py | 2 +- examples/test_swag_labs.py | 2 +- help_docs/customizing_test_runs.md | 2 +- help_docs/mobile_testing.md | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 152a1172..b400ec64 100755 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Tests are run with pytest -------- -

SeleniumBase Mobile Mode

+

SeleniumBase Mobile Mode

```bash pytest test_swag_labs.py --mobile @@ -65,7 +65,7 @@ pytest test_swag_labs.py --mobile

(Above: test_swag_labs.py in Mobile Mode.)

(Below: Same test running in Demo Mode.)

-

SeleniumBase Demo Mode

+

SeleniumBase Demo Mode

```bash pytest test_swag_labs.py --demo @@ -211,7 +211,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): @@ -514,7 +514,7 @@ The ``--report`` option gives you a fancy report after your test suite completes nosetests test_suite.py --report ``` -Example Nosetest Report +Example Nosetest Report (NOTE: You can add ``--show-report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show-report`` when running tests locally because it pauses the test run.) diff --git a/examples/ReadMe.md b/examples/ReadMe.md index 7e9adb46..3a701d29 100755 --- a/examples/ReadMe.md +++ b/examples/ReadMe.md @@ -32,7 +32,7 @@ Run an example test in Demo Mode: (highlight assertions) pytest my_first_test.py --demo ``` -
+
Run a different example in Demo Mode: @@ -40,7 +40,7 @@ Run a different example in Demo Mode: pytest test_swag_labs.py --demo ``` -
+
Run an example test in Headless Mode: (invisible browser) @@ -54,7 +54,7 @@ Run an example test using Chrome's mobile device emulator: (default settings) pytest test_swag_labs.py --mobile ``` -
+
Run tests with verbose output: (includes more details) @@ -68,7 +68,7 @@ Run a test on the Demo Site to try many SeleniumBase methods: pytest test_demo_site.py ``` -
+
Run tests multi-threaded using [n] threads: @@ -156,7 +156,7 @@ To make things easier, here's a simple GUI program that allows you to run a few python gui_test_runner.py ``` - + -------- diff --git a/examples/example_logs/ReadMe.md b/examples/example_logs/ReadMe.md index de6cbf13..893d0f6d 100755 --- a/examples/example_logs/ReadMe.md +++ b/examples/example_logs/ReadMe.md @@ -39,7 +39,7 @@ The ``--report`` option gives you a fancy report after your test suite completes ```bash nosetests test_suite.py --report --browser=chrome ``` -Example Nosetest Report +Example Nosetest Report (NOTE: You can add ``--show-report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show-report`` when running tests locally because it pauses the test run.) diff --git a/examples/swag_labs_suite.py b/examples/swag_labs_suite.py index bef4db44..14b09771 100755 --- a/examples/swag_labs_suite.py +++ b/examples/swag_labs_suite.py @@ -6,7 +6,7 @@ from seleniumbase import BaseCase class SwagLabsTests(BaseCase): def login_to_swag_labs(self, username="standard_user"): - """ Login to Swag Labs and verify that login was successful. """ + """ Login to Swag Labs and verify success. """ self.open("https://www.saucedemo.com/") if username not in self.get_text("#login_credentials"): self.fail("Invalid user for login: %s" % username) diff --git a/examples/test_swag_labs.py b/examples/test_swag_labs.py index 5574dfd3..1db9811a 100755 --- a/examples/test_swag_labs.py +++ b/examples/test_swag_labs.py @@ -4,7 +4,7 @@ from seleniumbase import BaseCase class SwagLabsTests(BaseCase): def login_to_swag_labs(self, username="standard_user"): - """ Login to Swag Labs and verify that login was successful. """ + """ Login to Swag Labs and verify success. """ self.open("https://www.saucedemo.com/") if username not in self.get_text("#login_credentials"): self.fail("Invalid user for login: %s" % username) diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md index bf9780ad..fd267762 100755 --- a/help_docs/customizing_test_runs.md +++ b/help_docs/customizing_test_runs.md @@ -276,7 +276,7 @@ The ``--report`` option gives you a fancy report after your test suite completes nosetests test_suite.py --report ``` -Example Nosetest Report +Example Nosetest Report (NOTE: You can add ``--show_report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show_report`` when running tests locally because it pauses the test run.) diff --git a/help_docs/mobile_testing.md b/help_docs/mobile_testing.md index 0cd6adb6..fc9a5cf0 100755 --- a/help_docs/mobile_testing.md +++ b/help_docs/mobile_testing.md @@ -44,7 +44,7 @@ To find real User-Agent strings, see: pytest test_swag_labs.py --mobile ``` -[](https://seleniumbase.io/cdn/gif/swag_mobile.gif) +[](https://seleniumbase.io/cdn/gif/swag_mobile.gif) Here's an example of configuring mobile settings for that test: