From f4f87288e01eb51820a16e4f1341a11ae4a11e17 Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 23 Jun 2023 22:46:19 +0900 Subject: [PATCH] add missing document for `EndColumn` template field at `-format` argument --- docs/usage.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 3fadd2952..64d1c9f05 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -122,14 +122,15 @@ The sequence can be traversed with `range` statement, which is like `for ... = r The error object has the following fields. -| Field | Description | Example | -|---------------------|----------------------------------------------------|------------------------------------------------------------------| -| `{{$err.Message}}` | Body of error message | `property "platform" is not defined in object type {os: string}` | -| `{{$err.Snippet}}` | Code snippet to indicate error position | ` node_version: 16.x\n ^~~~~~~~~~~~~` | -| `{{$err.Kind}}` | Name of rule the error belongs to | `expression` | -| `{{$err.Filepath}}` | Canonical relative file path of the error position | `.github/workflows/ci.yaml` | -| `{{$err.Line}}` | Line number of the error position (1-based) | `21` | -| `{{$err.Column}}` | Column number of the error position (1-based) | `20` | +| Field | Description | Example | +|----------------------|-------------------------------------------------------|------------------------------------------------------------------| +| `{{$err.Message}}` | Body of error message | `property "platform" is not defined in object type {os: string}` | +| `{{$err.Snippet}}` | Code snippet to indicate error position | ` node_version: 16.x\n ^~~~~~~~~~~~~` | +| `{{$err.Kind}}` | Name of rule the error belongs to | `expression` | +| `{{$err.Filepath}}` | Canonical relative file path of the error position | `.github/workflows/ci.yaml` | +| `{{$err.Line}}` | Line number of the error position (1-based) | `9` | +| `{{$err.Column}}` | Column number of the error's start position (1-based) | `11` | +| `{{$err.EndColumn}}` | Column number of the error's end position (1-based) | `23` | For example, the following simple iteration body