Skip to content

Commit 1de9a12

Browse files
committed
Update MasterQA docs
1 parent e804fda commit 1de9a12

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

examples/master_qa/ReadMe.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![](http://cdn2.hubspot.net/hubfs/100006/images/masterqa_logo-11.png "MasterQA")
22

3-
### MasterQA combines SeleniumBase automation with manual verification steps to bridge the gap between manual QA and automated QA.
3+
### MasterQA combines automation with manual verification steps.
44

55
![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa6.gif "MasterQA")
66

@@ -15,9 +15,9 @@ self.highlight_update_text("input#s", "Dragons\n")
1515
self.verify('Do you see "dragons" in the search results?')
1616
```
1717

18-
After the web browser performs various automated actions, a pop-up window will ask the user questions for each verification command.
18+
After each automation checkpoint, a pop-up window will ask the user questions for each verification command.
1919

20-
At the end of a full test run, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py), you'll see a results page that appears after responding to all the verification questions. (Failed verifications generate links to screenshots and log files.)
20+
When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
2121

2222
![](http://cdn2.hubspot.net/hubfs/100006/images/hybrid_screen.png "MasterQA")
2323

@@ -38,9 +38,9 @@ At the end of your test run, you'll receive a report with results, screenshots,
3838

3939
### Check out [masterqa_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py) to learn how to write your own MasterQA tests:
4040

41-
You'll notice that tests are written based on [SeleniumBase](http://seleniumbase.com), with the key difference of using a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now the test class will import ``MasterQA`` instead of ``BaseCase``.
41+
You'll notice that tests are written the same way as regular [SeleniumBase](http://seleniumbase.com) tests, with the key difference being a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now your Python test class will import ``MasterQA`` instead of ``BaseCase``.
4242

43-
To add a manual verification step, use ``self.verify()`` in the code after each part of the script that needs manual verification. If you want to include a custom question, add text inside that call (in quotes). Example:
43+
To add a manual verification step, use ``self.verify()`` in the code after each part of your test that needs a manual verification step. If you want to include a custom question, add text inside that call (in quotes). Example:
4444

4545
```python
4646
self.verify()

seleniumbase/masterqa/ReadMe.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![](http://cdn2.hubspot.net/hubfs/100006/images/masterqa_logo-11.png "MasterQA")
22

3-
### MasterQA combines SeleniumBase automation with manual verification steps to bridge the gap between manual QA and automated QA.
3+
### MasterQA combines automation with manual verification steps.
44

55
![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa6.gif "MasterQA")
66

@@ -15,9 +15,9 @@ self.highlight_update_text("input#s", "Dragons\n")
1515
self.verify('Do you see "dragons" in the search results?')
1616
```
1717

18-
After the web browser performs various automated actions, a pop-up window will ask the user questions for each verification command.
18+
After each automation checkpoint, a pop-up window will ask the user questions for each verification command.
1919

20-
At the end of a full test run, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py), you'll see a results page that appears after responding to all the verification questions. (Failed verifications generate links to screenshots and log files.)
20+
When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
2121

2222
![](http://cdn2.hubspot.net/hubfs/100006/images/hybrid_screen.png "MasterQA")
2323

@@ -38,9 +38,9 @@ At the end of your test run, you'll receive a report with results, screenshots,
3838

3939
### Check out [masterqa_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test.py) to learn how to write your own MasterQA tests:
4040

41-
You'll notice that tests are written based on [SeleniumBase](http://seleniumbase.com), with the key difference of using a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now the test class will import ``MasterQA`` instead of ``BaseCase``.
41+
You'll notice that tests are written the same way as regular [SeleniumBase](http://seleniumbase.com) tests, with the key difference being a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now your Python test class will import ``MasterQA`` instead of ``BaseCase``.
4242

43-
To add a manual verification step, use ``self.verify()`` in the code after each part of the script that needs manual verification. If you want to include a custom question, add text inside that call (in quotes). Example:
43+
To add a manual verification step, use ``self.verify()`` in the code after each part of your test that needs a manual verification step. If you want to include a custom question, add text inside that call (in quotes). Example:
4444

4545
```python
4646
self.verify()

0 commit comments

Comments
 (0)