From 520aa5da99b07cc77e7f5177fc921a4648aa0d81 Mon Sep 17 00:00:00 2001
From: DudaGod <dudkevich@yandex-team.ru>
Date: Wed, 23 Jan 2019 09:15:52 +0300
Subject: [PATCH] docs: fix info about "compareOpts"
---
doc/config.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/doc/config.md b/doc/config.md
index 4c525a5b4..762aca985 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -15,7 +15,10 @@ calibrate: false
tolerance: 3.5
antialiasingTolerance: 0,
compareOpts:
- stopOnFirstFail: true
+ stopOnFirstFail: false
+buildDiffOpts:
+ ignoreAntialiasing: true
+ ignoreCaret: true
httpTimeout: 5000
sessionRequestTimeout: 60000
sessionQuitTimeout: 5000
@@ -215,9 +218,12 @@ Settings list:
* `antialiasingTolerance` — read about this option in [looks-same](https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing).
-* `compareOpts` — extra options for images comparing. It's an Object with following fields:
- * `[stopOnFirstFail] {Boolean}` Only first pixel will be found if this option is true
- See [looks-same](https://github.com/gemini-testing/looks-same#comparing-images) documentation for the list of options.
+* `compareOpts` — extra options for comparing images. See [looks-same](https://github.com/gemini-testing/looks-same#comparing-images) documentation for the list of available options. Default values are:
+```javascript
+compareOpts: {
+ stopOnFirstFail: false
+}
+```
* `windowSize` — specify browser window dimensions (i.e. `1600x1200`). If not
specified, the size of the window depends on WebDriver. :warning: You can't set specific resolutions for browser Opera or mobile platforms. They use only full-screen resolution.