Skip to content

Commit b9088db

Browse files
committed
Update OutputFormatters.md to document the additional fileName property on each LintError object.
1 parent c19bf55 commit b9088db

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/OutputFormatters.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ module.exports = (options, params) => { ... }
2020

2121
Where `options` is an object that looks like:
2222

23-
- `results`: `Array` of [`markdownlint` `LintError` objects][markdownlint-d-ts]
23+
- `results`: `Array` of [`markdownlint` `LintError` objects][markdownlint-d-ts],
24+
each with an added `String` property `fileName` containing a relative path
2425
- `logMessage`: `Function` that takes a single `String` argument and logs it to
2526
standard output
2627
- `logError`: `Function` that takes a single `String` argument and logs it to

0 commit comments

Comments
 (0)