address review: add JSDoc

Expensify · Jun 12, 2024 · cfaaf5c · cfaaf5c
1 parent 11af4fd
commit cfaaf5c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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;