From 50ef25fda1f287ad25db62a10b5b698a9d87bbc5 Mon Sep 17 00:00:00 2001
From: Carlos Alcaide Corvo <ccorvo@hashicorp.com>
Date: Thu, 14 Oct 2021 13:35:41 -0700
Subject: [PATCH] Enhance function comments

---
 ui/desktop/tests/end2end/test-helpers.js | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/ui/desktop/tests/end2end/test-helpers.js b/ui/desktop/tests/end2end/test-helpers.js
index 261e4fd21..b76f3f812 100644
--- a/ui/desktop/tests/end2end/test-helpers.js
+++ b/ui/desktop/tests/end2end/test-helpers.js
@@ -44,12 +44,11 @@ exports.returnExecutablePath = (platform, arch) => {
 };
 
 /**
- *
- * @param {*} appWindow
- * @param {*} selector
+ * Performs a click with a workarouind due to an error with plain playwright click.
+ * More info about the issue here: https://github.com/microsoft/playwright/issues/1808
+ * @param {*} appWindow The current electron window.
+ * @param {*} selector The DOM element selector.
  */
 exports.customClick = async (appWindow, selector) => {
-  // Due to an error with await appWindow.click('button[type="submit"]'); we are using a workaround.
-  // More info about it here: https://github.com/microsoft/playwright/issues/1808
   await appWindow.$eval(selector, (element) => element.click());
 };