Skip to content

Commit da75a64

Browse files
committed
MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests
- Make sure all 4 actions are consistently worded
1 parent 7925287 commit da75a64

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/test/actions.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ See [dontSeeInPageSource docs on codeception.com](http://codeception.com/docs/mo
861861

862862
Attribute|Type|Use|Description
863863
---|---|---|---
864-
`userInput`|string|optional| Value for the form field.
864+
`html`|string|optional| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
865865
`stepKey`|string|required| A unique identifier of the action.
866866
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
867867
`before`|string|optional| `stepKey` of action that must be executed next.
@@ -870,8 +870,8 @@ Attribute|Type|Use|Description
870870
#### Example
871871

872872
```xml
873-
<!-- Verify that the page source does not contain the string "Sample text". -->
874-
<dontSeeInPageSource userInput="Sample text" stepKey="dontSeeInPageSource"/>
873+
<!-- Verify that the page source does not contain the raw source code `<h1 class="login-header">`. -->
874+
<dontSeeInPageSource userInput="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="dontSeeInPageSource"/>
875875
```
876876

877877
### dontSeeInSource
@@ -880,7 +880,7 @@ See [dontSeeInSource docs on codeception.com](http://codeception.com/docs/module
880880

881881
Attribute|Type|Use|Description
882882
---|---|---|---
883-
`html`|string|optional| HTML code to search for within the source code. The value must be entity-encoded. See example.
883+
`html`|string|optional| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
884884
`stepKey`|string|required| A unique identifier of the action.
885885
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
886886
`before`|string|optional| `stepKey` of action that must be executed next.
@@ -891,7 +891,7 @@ Attribute|Type|Use|Description
891891
You must encode the `html` using a tool such as [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')).
892892

893893
```xml
894-
<!-- Verify that the page does not contain the raw source code `<h1 class="login-header">`. -->
894+
<!-- Verify that the page source does not contain the raw source code `<h1 class="login-header">`. -->
895895
<dontSeeInSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="dontSeeInSource"/>
896896
```
897897

@@ -1936,7 +1936,7 @@ See [seeInPageSource docs on codeception.com](http://codeception.com/docs/module
19361936

19371937
Attribute|Type|Use|Description
19381938
---|---|---|---
1939-
`html`|string|optional| HTML code to be searched for within the document. The value must be encoded. See example.
1939+
`html`|string|optional| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
19401940
`stepKey`|string|required| A unique identifier of the action.
19411941
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
19421942
`before`|string|optional| `stepKey` of action that must be executed next.
@@ -1987,7 +1987,7 @@ Attribute|Type|Use|Description
19871987
You must encode the `html` using a tool such as [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')).
19881988

19891989
```xml
1990-
<!-- Verify that the page does contains the raw source code `<h1 class="login-header">`. -->
1990+
<!-- Verify that the page source contains the raw source code `<h1 class="login-header">`. -->
19911991
<seeInSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="seeInSource"/>
19921992
```
19931993

0 commit comments

Comments
 (0)