Refactor docs

vfile · Jun 8, 2023 · 35beb54 · 35beb54
1 parent 357e056
commit 35beb54
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -30,8 +30,7 @@ export class VFileMessage extends Error {
   /**
    * Create a message for `reason`.
    *
-   * > 👉 **Note**: in addition to the signature with `options`, there are
-   * > several legacy signatures still supported.
+   * > 🪦 **Note**: also has obsolete signatures.
    *
    * @overload
    * @param {string} reason

diff --git a/readme.md b/readme.md
@@ -96,8 +96,7 @@ There is no default export.
 
 Create a message for `reason`.
 
-> 👉 **Note**: in addition to the signature with `options`, there are
-> several legacy signatures still supported.
+> 🪦 **Note**: also has obsolete signatures.
 
 ###### Parameters
 
@@ -174,12 +173,12 @@ The following fields are documented and typed here.
 ## Types
 
 This package is fully typed with [TypeScript][].
-It exports no additional types.
+It exports the additional type [`Options`][api-options].
 
 ## Compatibility
 
 Projects maintained by the unified collective are compatible with maintained
-versions of Node.js (as of June 2023, that is Node.js 16+).
+versions of Node.js.
 
 When we cut a new major release, we drop support for unmaintained versions of
 Node.