diff --git a/docs/formatters/index.md b/docs/formatters/index.md index 519b6c9f384..0020f452799 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 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: "

"}} -{% endfor %} \ No newline at end of file +* [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"

" | remove: "

"}} ({{formatter.consumer}}-readable) +{% endfor %}