added comments

1 files changed, 9 insertions, 0 deletions

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,