From 28e9a01a8569fae2c8eccef9313d77a87de48695 Mon Sep 17 00:00:00 2001 From: Nick Heiner Date: Fri, 10 Jun 2016 16:43:36 -0400 Subject: [PATCH] Update docs to make `fix` param more clear in NodeJS API See #6366. --- docs/developer-guide/nodejs-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-guide/nodejs-api.md b/docs/developer-guide/nodejs-api.md index fdbe551a71f0..480135016724 100644 --- a/docs/developer-guide/nodejs-api.md +++ b/docs/developer-guide/nodejs-api.md @@ -155,7 +155,7 @@ The `CLIEngine` is a constructor, and you can create a new instance by passing i * `envs` - An array of environments to load (default: empty array). Corresponds to `--env`. * `extensions` - An array of filename extensions that should be checked for code. The default is an array containing just `".js"`. Corresponds to `--ext`. * `globals` - An array of global variables to declare (default: empty array). Corresponds to `--global`. -* `fix` - True indicates that fixes should be applied to the text when possible. +* `fix` - True indicates that fixes should be included with the output report, and that errors and warnings should not be listed if they can be fixed. However, the files on disk will not be changed. To persist changes to disk, call [`outputFixes()`](#outputfixes). * `ignore` - False disables use of `.eslintignore`, `ignorePath` and `ignorePattern` (default: true). Corresponds to `--no-ignore`. * `ignorePath` - The ignore file to use instead of `.eslintignore` (default: null). Corresponds to `--ignore-path`. * `ignorePattern` - Glob patterns for paths to ignore. String or array of strings.