From cfd760db7c4d6b7c3f9f9aa8fe53ed4bf2f3affc Mon Sep 17 00:00:00 2001
From: Ivan Chen <ivan@tagg.id>
Date: Mon, 29 Mar 2021 14:20:52 -0400
Subject: added comments

---
 src/utils/users.ts | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src')

diff --git a/src/utils/users.ts b/src/utils/users.ts
index 0b8a0582..f9d6d6b7 100644
--- a/src/utils/users.ts
+++ b/src/utils/users.ts
@@ -175,6 +175,15 @@ export const defaultUserProfile = () => {
   return defaultImage;
 };
 
+/**
+ * Used to determine whether the logged-in user is able to view userX's private
+ * information or not.
+ *
+ * @param state redux store's root state
+ * @param userXId target userX's id
+ * @param screenType current screen type
+ * @returns true if abel to view private info, false otherwise
+ */
 export const canViewProfile = (
   state: RootState,
   userXId: string | undefined,
-- 
cgit v1.2.3-70-g09d2