From d1e24ff097a4a2f99faa1a6e43fae45d13e79b71 Mon Sep 17 00:00:00 2001
From: Jack Bates <jack@nottheoilrig.com>
Date: Mon, 4 Apr 2022 01:13:16 -0700
Subject: [PATCH] Fix types of rule arguments

Closes GH-289.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
---
 packages/unified-lint-rule/index.d.ts | 2 +-
 readme.md                             | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/packages/unified-lint-rule/index.d.ts b/packages/unified-lint-rule/index.d.ts
index 7ee1944..326df65 100644
--- a/packages/unified-lint-rule/index.d.ts
+++ b/packages/unified-lint-rule/index.d.ts
@@ -19,7 +19,7 @@ export function lintRule<Tree extends Node = Node, Options = unknown>(
   name: string | RuleMeta,
   rule: Rule<Tree, Options>
 ): Plugin<
-  void[] | [Options | Label | Severity] | [boolean | Label | Severity, Options],
+  void[] | [Options | [boolean | Label | Severity, (Options | undefined)?]],
   Tree
 >
 
diff --git a/readme.md b/readme.md
index f7df9b3..41fabde 100644
--- a/readme.md
+++ b/readme.md
@@ -269,7 +269,8 @@ remark()
   .use(remarkLintUnorderedListMarkerStyle, '*')
   .use(remarkLintUnorderedListMarkerStyle, ['on', '*'])
   .use(remarkLintUnorderedListMarkerStyle, [1, '*'])
-  // The following rule accepts a number, numbers *must* be passed in arrays:
+  // The following rule accepts a number:
+  .use(remarkLintMaximumLineLength, 72)
   .use(remarkLintMaximumLineLength, ['on', 72])
   .use(remarkLintMaximumLineLength, [1, 72])
 ```