Skip to content

Commit

Permalink
Update LintMessage docs
Browse files Browse the repository at this point in the history
This updates existing documented properties to match the updated `LintMessage`
type and implementations.

`messageId`, `nodeType`, and `suppressions` remain undocumented.
  • Loading branch information
btmills committed Apr 9, 2023
1 parent 406c2b0 commit c519894
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/src/extend/custom-processors.md
Expand Up @@ -65,13 +65,13 @@ type LintMessage = {
column: number;

/// The 1-based line number of the end location.
endLine: number;
endLine?: number;

/// The 1-based column number of the end location.
endColumn: number;
endColumn?: number;

/// If `true`, this is a fatal error.
fatal: boolean;
fatal?: boolean;

/// Information for an autofix.
fix: Fix;
Expand Down
4 changes: 2 additions & 2 deletions docs/src/integrate/nodejs-api.md
Expand Up @@ -397,9 +397,9 @@ The `LintMessage` value is the information of each linting error. The `messages`
`true` if this is a fatal error unrelated to a rule, like a parsing error.
* `message` (`string`)<br>
The error message.
* `line` (`number | undefined`)<br>
* `line` (`number`)<br>
The 1-based line number of the begin point of this message.
* `column` (`number | undefined`)<br>
* `column` (`number`)<br>
The 1-based column number of the begin point of this message.
* `endLine` (`number | undefined`)<br>
The 1-based line number of the end point of this message. This property is undefined if this message is not a range.
Expand Down

0 comments on commit c519894

Please sign in to comment.