From b49cea5f33b295c21a469c50c940c94e321f9853 Mon Sep 17 00:00:00 2001
From: haad <haad@headbanggames.com>
Date: Fri, 30 Jun 2023 08:14:06 +0300
Subject: [PATCH] Clarify OrbitDB AccessController documentation

---
 src/access-controllers/orbitdb.js | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/src/access-controllers/orbitdb.js b/src/access-controllers/orbitdb.js
index c8f5b28..baf62ca 100644
--- a/src/access-controllers/orbitdb.js
+++ b/src/access-controllers/orbitdb.js
@@ -26,7 +26,7 @@ const type = 'orbitdb'
  * Defines an OrbitDB access controller.
  * @param {Object} options Various options for configuring the
  * IPFSAccessController.
- * @param {Array} [params.write] An array of identity ids who can write to the
+ * @param {Array} [params.write] An array of ids of identities who can write to the
  * database.
  * @return {module:AccessControllers.AccessControllers-OrbitDB} An
  * IPFSAccessController function.
@@ -69,7 +69,7 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
    *
    * The returned capabilities will be a mixture of admin and write access
    * addresses.
-   * @return {Array} A list of addresses with admin and write access.
+   * @return {Array} A list of ids of identities with admin and write access.
    * @memberof module:AccessControllers.AccessControllers-OrbitDB
    * @instance
    */
@@ -97,7 +97,7 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
   }
 
   /**
-   * Gets a list of addresses with the specified capability.
+   * Gets a list of identities with the specified capability.
    * @param {string} capability A capability (e.g. write).
    * @return {Array} One or more addresses with the spcified capability.
    * @memberof module:AccessControllers.AccessControllers-OrbitDB
@@ -118,10 +118,10 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
   }
 
   /**
-   * Checks whether an address has a capability.
+   * Checks whether an identity has a capability.
    * @param {string} capability A capability (e.g. write).
-   * @param {string} key An address.
-   * @return {boolean} True if the address has the capability, false
+   * @param {string} key An id of an identity.
+   * @return {boolean} True if the identity has the capability, false
    * otherwise.
    * @memberof module:AccessControllers.AccessControllers-OrbitDB
    * @instance
@@ -133,10 +133,10 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
   }
 
   /**
-   * Grants a capability to an address, storing it to the access control
+   * Grants a capability to an identity, storing it to the access control
    * database.
    * @param {string} capability A capability (e.g. write).
-   * @param {string} key An address.
+   * @param {string} key An id of an identity.
    * @memberof module:AccessControllers.AccessControllers-OrbitDB
    * @instance
    */
@@ -147,10 +147,10 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
   }
 
   /**
-   * Revokes a capability from an address, removing it from the access control
+   * Revokes a capability from an identity, removing it from the access control
    * database.
    * @param {string} capability A capability (e.g. write).
-   * @param {string} key An address.
+   * @param {string} key An id of an identity.
    * @memberof module:AccessControllers.AccessControllers-OrbitDB
    * @instance
    */