From ce8235ff0408f69dc0bc01ad778faf54a064a522 Mon Sep 17 00:00:00 2001
From: haad <haad@headbanggames.com>
Date: Fri, 30 Jun 2023 08:48:35 +0300
Subject: [PATCH] Fix links and add clarification in Identities api docs

---
 src/identities/identities.js | 2 +-
 src/identities/identity.js   | 5 ++---
 2 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/identities/identities.js b/src/identities/identities.js
index e005d01..c85d537 100644
--- a/src/identities/identities.js
+++ b/src/identities/identities.js
@@ -52,7 +52,7 @@ const Identities = async ({ keystore, path, storage, ipfs } = {}) => {
   /**
    * Gets an identity by hash.
    * @param {string} hash An identity hash.
-   * @return {Identity} An instance of identity.
+   * @return {module:Identities~Identity} An instance of identity.
    * @memberof module:Identities~Identities
    * @instance
    */
diff --git a/src/identities/identity.js b/src/identities/identity.js
index 8290563..00444ef 100644
--- a/src/identities/identity.js
+++ b/src/identities/identity.js
@@ -13,12 +13,11 @@ const hashStringEncoding = base58btc
  * @property {object} publicKey A public key.
  * @property {object} signatures A signed identity id and public key.
  * @property {string} type The type of identity provider.
- * @property {function} sign A sign function.
- * @property {function} verify A verify function.
+ * @property {function} sign A sign function to sign data using this identity.
+ * @property {function} verify A verify function to verify data signed by this identity.
  */
 const Identity = async ({ id, publicKey, signatures, type, sign, verify } = {}) => {
   /**
-   * @namespace module:Identities~Identity
    * @description The Identity instance. Returned by
    * [Identities.createIdentity()]{@link module:Identities~Identities#createIdentity}.
    */