From 5ce4c2af9891eae8085e57ecb7cbfe94a4e2aefd Mon Sep 17 00:00:00 2001 From: Patrice Sandhu Date: Sat, 22 Aug 2020 18:19:15 -0700 Subject: [PATCH 1/2] Docs: Fix typo semicolumns in providing suggestions docs --- docs/developer-guide/working-with-rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-guide/working-with-rules.md b/docs/developer-guide/working-with-rules.md index 2f47c316ccb..2b814e7a98b 100644 --- a/docs/developer-guide/working-with-rules.md +++ b/docs/developer-guide/working-with-rules.md @@ -375,7 +375,7 @@ context.report({ {% endraw %} ``` -Note: Suggestions will be applied as a stand-alone change, without triggering multipass fixes. Each suggestion should focus on a singular change in the code and should not try to conform to user defined styles. For example, if a suggestion is adding a new statement into the codebase, it should not try to match correct indentation, or confirm to user preferences on presence/absence of semicolumns. All of those things can be corrected by multipass autofix when the user triggers it. +Note: Suggestions will be applied as a stand-alone change, without triggering multipass fixes. Each suggestion should focus on a singular change in the code and should not try to conform to user defined styles. For example, if a suggestion is adding a new statement into the codebase, it should not try to match correct indentation, or confirm to user preferences on presence/absence of semicolons. All of those things can be corrected by multipass autofix when the user triggers it. Best practices for suggestions: From 6b4489d019910353c4b65d0ad037d09e41d4e585 Mon Sep 17 00:00:00 2001 From: Patrice Sandhu Date: Sun, 23 Aug 2020 13:54:39 -0700 Subject: [PATCH 2/2] Docs: Fix missing article before noun --- 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 991a1cbcd26..8bfa9aecbf1 100644 --- a/docs/developer-guide/nodejs-api.md +++ b/docs/developer-guide/nodejs-api.md @@ -926,7 +926,7 @@ The top-level report object has a `results` array containing all linting results * `source` - The source code for the given file. This property is omitted if this file has no errors/warnings or if the `output` property is present. * `output` - The source code for the given file with as many fixes applied as possible, so you can use that to rewrite the files if necessary. This property is omitted if no fix is available. -The top-level report object also has `errorCount` and `warningCount` which give the exact number of errors and warnings respectively on all the files. Additionally, `usedDeprecatedRules` signals any deprecated rules used and their replacement (if available). Specifically, it is array of objects with properties like so: +The top-level report object also has `errorCount` and `warningCount` which give the exact number of errors and warnings respectively on all the files. Additionally, `usedDeprecatedRules` signals any deprecated rules used and their replacement (if available). Specifically, it is an array of objects with properties like so: * `ruleId` - The name of the rule (e.g. `indent-legacy`). * `replacedBy` - An array of rules that replace the deprecated rule (e.g. `["indent"]`).