From cfaaf5c9a1476c2843bcde465aeb53d1e1d843ee Mon Sep 17 00:00:00 2001
From: Jakub Kosmydel <104823336+kosmydel@users.noreply.github.com>
Date: Wed, 12 Jun 2024 10:39:20 +0200
Subject: [PATCH] address review: add JSDoc

---
 src/libs/SidebarUtils.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libs/SidebarUtils.ts b/src/libs/SidebarUtils.ts
index 4af6ceb622af..a9239e6a4fa0 100644
--- a/src/libs/SidebarUtils.ts
+++ b/src/libs/SidebarUtils.ts
@@ -62,6 +62,10 @@ function compareStringDates(a: string, b: string): 0 | 1 | -1 {
     return 0;
 }
 
+/**
+ * A mini report object that contains only the necessary information to sort reports.
+ * This is used to avoid copying the entire report object and only the necessary information.
+ */
 type MiniReport = {
     reportID?: string;
     displayName: string;