diff --git a/README.md b/README.md index 63f43c14..ad428589 100644 --- a/README.md +++ b/README.md @@ -620,9 +620,15 @@ By default, properly-formatted inline comments can be used to create exceptions for parts of a document. Setting `noInlineConfig` to `true` ignores all such comments. -##### options.resultVersion +##### ~~options.resultVersion~~ -DEPRECATED +This property is *deprecated* and can be removed. The default format of the +`result` object remains the same as setting `resultVersion` to `3`. For +continued access to other (previously *deprecated*) formats: + +```javascript +import { convertToResultVersion0, convertToResultVersion1, convertToResultVersion2 } from "markdownlint/helpers"; +``` ##### options.strings diff --git a/test/markdownlint-test.mjs b/test/markdownlint-test.mjs index b797c22b..7c973124 100644 --- a/test/markdownlint-test.mjs +++ b/test/markdownlint-test.mjs @@ -646,7 +646,7 @@ test("readmeHeadings", (t) => new Promise((resolve) => { "##### options.handleRuleFailures", "##### options.markdownItFactory", "##### options.noInlineConfig", - "##### options.resultVersion", + "##### ~~options.resultVersion~~", "##### options.strings", "#### callback", "#### result",