Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Docs: add note to docs about zero-indexing for machine formatters #4544

Merged
merged 2 commits into from Mar 2, 2019
Merged

Docs: add note to docs about zero-indexing for machine formatters #4544

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6e5342
Docs: add note to docs about zero-indexing for machine formatters
theoretick Feb 25, 2019
d6cbbd5
Update index.md
Mar 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/formatters/index.md
View file
Open in desktop
Expand Up @@ -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).
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

### Built-in formatters

{% assign formatters = site.data.formatters | sort: "name" %}
{% for formatter in formatters %}
* [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"<p>" | remove: "</p>"}}
* [{{formatter.formatterName}}]({{formatter.formatterName}}) - {{formatter.description | markdownify | remove:"<p>" | remove: "</p>"}} ({{formatter.consumer}}-readable)
{% endfor %}