From a6e5342181a52c9824200472ce916b6e54b7bc5e Mon Sep 17 00:00:00 2001 From: Lucas Charles Date: Mon, 25 Feb 2019 09:38:06 -0800 Subject: [PATCH 1/2] Docs: add note to docs about zero-indexing for machine formatters --- docs/formatters/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/formatters/index.md b/docs/formatters/index.md index 519b6c9f384..dc56bb695eb 100644 --- a/docs/formatters/index.md +++ b/docs/formatters/index.md @@ -8,9 +8,12 @@ order: 2 Lint _formatters_ allow for transformation of lint results into various forms before outputting to stdout or a file. +Formatters are split into two categories: _human-readable and machine-readable_. Please note that for machine-readable +formatters all positioning is zero-indexed (Lines start with zero), where as human-readable is not (Lines start with one). + ### Built-in formatters {% assign formatters = site.data.formatters | sort: "name" %} {% for formatter in formatters %} -* [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"

" | remove: "

"}} +* [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"

" | remove: "

"}} ({{formatter.consumer}}-readable) {% endfor %} \ No newline at end of file From d6cbbd5da54a6240013b6477e95d5b7ca8219747 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sat, 2 Mar 2019 13:23:25 -0500 Subject: [PATCH 2/2] Update index.md --- docs/formatters/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/formatters/index.md b/docs/formatters/index.md index dc56bb695eb..0020f452799 100644 --- a/docs/formatters/index.md +++ b/docs/formatters/index.md @@ -8,12 +8,12 @@ order: 2 Lint _formatters_ allow for transformation of lint results into various forms before outputting to stdout or a file. -Formatters are split into two categories: _human-readable and machine-readable_. Please note that for machine-readable -formatters all positioning is zero-indexed (Lines start with zero), where as human-readable is not (Lines start with one). +Formatters are split into two categories: _human-readable_ and _machine-readable_. Please note that for machine-readable +formatters formatters all positioning is zero-indexed (lines start with zero), whereas human-readable formatters are not (lines start with one). ### Built-in formatters {% assign formatters = site.data.formatters | sort: "name" %} {% for formatter in formatters %} * [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"

" | remove: "

"}} ({{formatter.consumer}}-readable) -{% endfor %} \ No newline at end of file +{% endfor %}