Update sorting JSDoc

Expensify · Mar 24, 2023 · 9fc387b · 9fc387b
1 parent e50042e
commit 9fc387b
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/libs/ReportActionsUtils.js b/src/libs/ReportActionsUtils.js
@@ -49,8 +49,11 @@ function isOptimisticAction(reportAction) {
 }
 
 /**
- * Sort an array of reportActions by their created timestamp first, and reportActionID second
- * This gives us a stable order even in the case of multiple reportActions created on the same millisecond
+ * Sort an array of reportActions by:
+ *
+ * - Finalized actions always are "later" than optimistic actions
+ * - then sort by created timestamp
+ * - then sort by reportActionID. This gives us a stable order even in the case of multiple reportActions created on the same millisecond
  *
  * @param {Array} reportActions
  * @param {Boolean} shouldSortInDescendingOrder