From 9621e3d1ed8158a2efa6559e4848699e7148bef7 Mon Sep 17 00:00:00 2001
From: Eugen Ciur <eugen@papermerge.com>
Date: Mon, 11 Oct 2021 07:37:16 +0200
Subject: [PATCH] a little bit of documentation never hurts

---
 app/utils/index.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/app/utils/index.js b/app/utils/index.js
index 7f821a0..a81c844 100644
--- a/app/utils/index.js
+++ b/app/utils/index.js
@@ -47,6 +47,12 @@ function group_perms_by_model(permissions) {
 }
 
 function are_sets_equal(set1, set2) {
+  /*
+    Returns `true` if given sets are equal and `false` otherwise.
+
+    `set1` and `set2` are expected to be instances of javascript `Set`
+    class.
+  */
   let same_size, same_values;
 
   same_size = (a, b) => a.size === b.size;
-- 
GitLab