From cc681f362b56a324c24a2592f7d3f7b724fc9c1c Mon Sep 17 00:00:00 2001
From: Philipp Fritsche <ph.fritsche@gmail.com>
Date: Wed, 28 Apr 2021 12:00:06 +0200
Subject: [PATCH] fix(keyboard): add link to README in key descriptor error

---
 src/__tests__/keyboard/index.ts | 2 +-
 src/keyboard/getNextKeyDef.ts   | 4 +++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/__tests__/keyboard/index.ts b/src/__tests__/keyboard/index.ts
index 1843c2aa..4b573940 100644
--- a/src/__tests__/keyboard/index.ts
+++ b/src/__tests__/keyboard/index.ts
@@ -95,7 +95,7 @@ describe('error', () => {
     expect(err).toHaveBeenCalledWith(expect.any(Error) as unknown)
     expect(err.mock.calls[0][0]).toHaveProperty(
       'message',
-      'Expected key descriptor but found "!" in "{!"',
+      expect.stringContaining('Expected key descriptor but found "!" in "{!"'),
     )
   })
 
diff --git a/src/keyboard/getNextKeyDef.ts b/src/keyboard/getNextKeyDef.ts
index f8420d60..358dee63 100644
--- a/src/keyboard/getNextKeyDef.ts
+++ b/src/keyboard/getNextKeyDef.ts
@@ -141,5 +141,7 @@ function getErrorMessage(
   found: string | undefined,
   text: string,
 ) {
-  return `Expected ${expected} but found "${found ?? ''}" in "${text}"`
+  return `Expected ${expected} but found "${found ?? ''}" in "${text}"
+    See https://github.com/testing-library/user-event/blob/master/README.md#keyboardtext-options
+    for more information about how userEvent parses your input.`
 }