From 483b597b82802aa719d7593406a74ebe0d6ebe87 Mon Sep 17 00:00:00 2001 From: dlewis-ald Date: Wed, 22 May 2019 12:43:15 +0100 Subject: [PATCH] Update OPTIONS.md Fixed indention of `largeImageThreshold` documentation --- docs/OPTIONS.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/OPTIONS.md b/docs/OPTIONS.md index ae2dcf2..80bbc1f 100644 --- a/docs/OPTIONS.md +++ b/docs/OPTIONS.md @@ -448,12 +448,11 @@ This will retun all compare data, not only the mismatch percentage Allowable value of misMatchPercentage that prevents saving image with differences - - ### `largeImageThreshold` - - **Type:** `number` - - **Default:** `0` - - **Mandatory:** no - - **Remark:** *Can also be used for `checkElement`, `checkScreen()` and `checkFullPageScreen()`. It will override the plugin setting* +### `largeImageThreshold` +- **Type:** `number` +- **Default:** `0` +- **Mandatory:** no +- **Remark:** *Can also be used for `checkElement`, `checkScreen()` and `checkFullPageScreen()`. It will override the plugin setting* - Comparing large images can lead to performance issues. - When providing a number for the amount of pixels here (higher then 0), the comparison algorithm skips pixels when the image width or height is larger than `largeImageThreshold` pixels. +Comparing large images can lead to performance issues. +When providing a number for the amount of pixels here (higher then 0), the comparison algorithm skips pixels when the image width or height is larger than `largeImageThreshold` pixels.