Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Correct typo-ed references to RuleOnErrorInfo.details to detail.

Browse source
This commit is contained in:
David Anson 2021-09-25 16:23:37 -07:00
parent a852407c88
commit a5bfaa8a7d
4 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/CustomRules.md
View file

@ -51,7 +51,7 @@ A rule is implemented as an `Object` with one optional and four required propert
- `config` is an `Object` corresponding to the rule's entry in `options.config` (if present).
- `onError` is a function that takes a single `Object` parameter with one required and four optional properties:
- `lineNumber` is a required `Number` specifying the 1-based line number of the error.
- `details` is an optional `String` with information about what caused the error.
- `detail` is an optional `String` with information about what caused the error.
- `context` is an optional `String` with relevant text surrounding the error location.
- `range` is an optional `Array` with two `Number` values identifying the 1-based column and length of the error.
- `fixInfo` is an optional `Object` with information about how to fix the error (all properties are optional, but