Skip to content

Commit 7ffc7cb

Browse files
Apply suggestions from code review
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
1 parent c316416 commit 7ffc7cb

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/get-started/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Get started
66

7-
Downloading and running Doc Detective is simple, but let's walk through it and run tests on a few sample files.
7+
Downloading and running Doc Detective is straightforward. Follow these steps to run tests on a few sample files.
88

99
1. Install prerequisites:
1010

docs/references/schemas/saveScreenshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description | string | Optional. Description of the step. |
1212
action | string | Required. The action to perform. |
1313
path | string | Optional. File path of the PNG file, relative to `directory`. If not specified, the file name is the ID of the step. |
1414
directory | string | Optional. Directory of the PNG file. If the directory doesn't exist, creates the directory. |
15-
maxVariation | number | Optional. Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored. | `5`
15+
maxVariation | number | Optional. Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, the system ignores this value. | `5`
1616
overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists.
1717
If `byVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `byVariation` | `false`
1818

0 commit comments

Comments
 (0)