Skip to content

Commit db74715

Browse files
committed
Add missing documentation for "directory" property of options object passed to output formatters.
1 parent 7dd9a60 commit db74715

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

.github/dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ markdownlint-cli2-formatter-pretty
2626
markdownlint-cli2-formatter-sarif
2727
markdownlint-cli2-formatter-summarize
2828
npm
29+
POSIX
2930
pre-commit
3031
SARIF
3132
subdirectories

doc/OutputFormatters.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ module.exports = (options, params) => { ... }
2020

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

23+
- `directory`: `String` that identifies the base directory for relative paths
24+
(using POSIX syntax)
2325
- `results`: `Array` of [`markdownlint` `LintError` objects][markdownlint-d-ts],
2426
each with an added `String` property `fileName` containing a relative path
2527
- `logMessage`: `Function` that takes a single `String` argument and logs it to

0 commit comments

Comments
 (0)