From 2f9439b6907b1796f74693d804da657082ea215f Mon Sep 17 00:00:00 2001
From: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
Date: Thu, 14 Sep 2023 12:35:12 -0700
Subject: [PATCH] Explain injectSharedRendererTestsStandalone

---
 test/playwright/SharedRendererTests.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/test/playwright/SharedRendererTests.ts b/test/playwright/SharedRendererTests.ts
index b29f45cf..76c5051b 100644
--- a/test/playwright/SharedRendererTests.ts
+++ b/test/playwright/SharedRendererTests.ts
@@ -1150,6 +1150,11 @@ export function injectSharedRendererTests(ctx: ISharedRendererTestContext): void
   });
 }
 
+/**
+ * Injects shared renderer tests where it's required to re-initialize the terminal for each test.
+ * This is much slower than just calling `Terminal.reset` but testing some features needs this
+ * treatment.
+ */
 export function injectSharedRendererTestsStandalone(ctx: ISharedRendererTestContext): void {
   test.beforeEach(async () => {
     // Recreate terminal