Skip to content

Commit b64e2ad

Browse files
Added extra comments for "Eyes open"
1 parent c5be45d commit b64e2ad

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

tests/conftest.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,18 @@ def eyes(
126126
"""
127127
Creates the Applitools Eyes object connected to the VisualGridRunner and set its configuration.
128128
Then, opens Eyes to start visual testing before the test, and closes Eyes at the end of the test.
129+
130+
Opening Eyes requires 4 arguments:
131+
1. The WebDriver object to "watch".
132+
2. The name of the application under test.
133+
All tests for the same app should share the same app name.
134+
Set this name wisely: Applitools features rely on a shared app name across tests.
135+
3. The name of the test case for the given application.
136+
Additional unique characteristics of the test may also be specified as part of the test name,
137+
such as localization information ("Home Page - EN") or different user permissions ("Login by admin").
138+
4. The viewport size for the local browser.
139+
Eyes will resize the web browser to match the requested viewport size.
140+
This parameter is optional but encouraged in order to produce consistent results.
129141
"""
130142

131143
eyes = Eyes(runner)

0 commit comments

Comments
 (0)