From d4264c55f761ebc0d74f2c20b14907c994f38f14 Mon Sep 17 00:00:00 2001
From: Pavel Zavora <pavel.zavora@bonitoo.io>
Date: Fri, 27 May 2022 12:37:35 +0200
Subject: [PATCH] chore(ui): improve docs

---
 .../util/computeUsersEffectiveDBPermissions.ts   |  6 +-----
 .../containers/influxdb/util/userPermissions.ts  | 16 +++++++++-------
 2 files changed, 10 insertions(+), 12 deletions(-)

diff --git a/ui/src/admin/containers/influxdb/util/computeUsersEffectiveDBPermissions.ts b/ui/src/admin/containers/influxdb/util/computeUsersEffectiveDBPermissions.ts
index d18f6b20f..e14cd8992 100644
--- a/ui/src/admin/containers/influxdb/util/computeUsersEffectiveDBPermissions.ts
+++ b/ui/src/admin/containers/influxdb/util/computeUsersEffectiveDBPermissions.ts
@@ -1,15 +1,11 @@
 import {User} from 'src/types/influxAdmin'
 
-/** Array of users, with Arrays of databases containing permission records (or record changes) */
+/** Array of users with Arrays of databases containing granted permission records */
 type UsersDBPermissions = Array<Array<Record<string, boolean>>>
 /**
  * Creates effective user permissions as a record
  * that contains permission names as keys and `true` values
  * for every assigned permission.
- *
- * @param dbNames
- * @param users
- * @returns
  */
 export default function computeUsersEffectiveDBPermissions(
   users: User[],
diff --git a/ui/src/admin/containers/influxdb/util/userPermissions.ts b/ui/src/admin/containers/influxdb/util/userPermissions.ts
index f74ae3b5c..3c86028b4 100644
--- a/ui/src/admin/containers/influxdb/util/userPermissions.ts
+++ b/ui/src/admin/containers/influxdb/util/userPermissions.ts
@@ -1,13 +1,12 @@
 import {User, UserPermission} from 'src/types/influxAdmin'
 
-/** Record with database keys and values being a record of granted permissions or permission changes */
+/** Record with databases as keys and values being a record of granted permissions or permission changes */
 export type UserDBPermissions = Record<string, Record<string, boolean>>
 
 /**
- * Create a record of user's database permissions, organized by every database that
- * has some granted permissions.
+ * ComputeUserPermissions creates a record of user's database permissions.
  * @param user infludb user
- * @param isEnterprise enteprise InfluxDB flag means that <ALL>-scoped permissions are mapped to an extra `''` database.
+ * @param isEnterprise enteprise InfluxDB flag means that all-scoped permissions are mapped to an extra '' database.
  */
 export function computeUserPermissions(
   user: User,
@@ -25,8 +24,9 @@ export function computeUserPermissions(
 }
 
 /**
- * Computes changes in user permissions for a specific db and permission,
- * having original permission and a set of changes, return a new set of changes.
+ * ComputeUserPermissionsChange computes changes in user permissions
+ * for a specific db and permission, having original user permission
+ * and a set of already performed changes.
  */
 export function computeUserPermissionsChange(
   db: string,
@@ -61,7 +61,9 @@ export function computeUserPermissionsChange(
 }
 
 /**
- * Creates server's user permissions out of existing and changed user permissions.
+ * ToUserPermissions creates server-side's user permissions
+ * out of existing and changed user permissions, optionally
+ * appended to supplied user permissions.
  */
 export function toUserPermissions(
   userPermissions: UserDBPermissions,