From cefc4fc49b8ca6a0b5f14666fe74bba4a58606f5 Mon Sep 17 00:00:00 2001
From: eliza <eli97736@esri.com>
Date: Thu, 6 Jul 2023 16:34:06 -0700
Subject: [PATCH] refactor: Add implementation example to util doc

---
 packages/calcite-components/src/tests/utils.ts | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/packages/calcite-components/src/tests/utils.ts b/packages/calcite-components/src/tests/utils.ts
index 381090826be..30c171c4889 100644
--- a/packages/calcite-components/src/tests/utils.ts
+++ b/packages/calcite-components/src/tests/utils.ts
@@ -155,6 +155,15 @@ export async function getElementXY(
  * Note that this util should only be used for test debugging purposes and not be included in a test.
  * Based on https://github.com/puppeteer/puppeteer/issues/4378#issuecomment-499726973
  *
+ * @example
+ * import { visualizeMouseCursor } from "../../tests/utils";
+ *
+ * const page = await newE2EPage();
+ * await page.setContent(`<calcite-tooltip>Content</calcite-tooltip>`);
+ *
+ * await visualizeMouseCursor(page);
+ * await page.waitForChanges();
+ *
  * @param {E2EPage} page - the e2e page
  */
 export async function visualizeMouseCursor(page: E2EPage): Promise<void> {