Merge pull request #218 from terminusdb/docs-update

Docs update

Author: Francesca-Bit

lib/woqlClient.js

@@ -1468,9 +1468,9 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * Get the patch of difference between two documents.
  * @param {object} before - The current state of JSON document
  * @param {object} after - The updated state of JSON document
- * @param {object} [options] - {keep:{}} Options to send to the diff endpoint
- * the diff api outputs the changes between the input (JSON Object),
- * but you can list the properties that you would like to see in the diff result in any case.
+ * @param {object} [options] - {keep:{}} Options to send to the diff endpoint.
+ * The diff api outputs the changes between the input (branches or commits),
+ * in options you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  * client.getJSONDiff(
@@ -1542,12 +1542,12 @@ WOQLClient.prototype.getVersionObjectDiff = function (dataVersion, jsonObject, i
 /**
  * Get the patch of difference between branches or commits.
  * @param {string} beforeVersion - Before branch/commit to compare
- * @param {string} afterVersion -  Before branch/commit to compare
- * @param {string} [id] - The object id to be diffed,
+ * @param {string} afterVersion -  After branch/commit to compare
+ * @param {string} [id] - The document id to be diffed,
  * if it is omitted all the documents will be compared
- * @param {object} [options] - {keep:{}} Options to send to the diff endpoint
- * the diff api outputs the changes between the input (branches or commits),
- * but you can list the properties that you would like to see in the diff result in any case.
+ * @param {object} [options] - {keep:{}} Options to send to the diff endpoint.
+ * The diff api outputs the changes between the input (branches or commits),
+ * in options you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  * //This is to view all the changes between two commits
@@ -1600,16 +1600,16 @@ WOQLClient.prototype.getVersionDiff = function (beforeVersion, afterVersion, id,
 };
 
 /**
- * Diff two different commits and apply changes on the current branch/commit
- * if you would like to change branch or commit before apply use client.checkout("branchName")
+ * Diff two different commits and apply changes on the current branch/commit.
+ * If you would like to change branch or commit before apply use client.checkout("branchName")
  * @param {string} beforeVersion - Before branch/commit to compare
- * @param {string} afterVersion - Before branch/commit to compare
+ * @param {string} afterVersion - After branch/commit to compare
  * @param {string} message - apply commit message
- * @param {boolean} [match_final_state] -  the deafult value is false
+ * @param {boolean} [match_final_state] -  the default value is false
  * @param {object} [options] - {keep:{}} Options to send to the apply endpoint
  * @example
  * client.checkout("mybranch")
- * client.apply("main","mybranch").then(result=>{
+ * client.apply("main","mybranch","merge main").then(result=>{
  *    console.log(result)
  * })
  */

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminusdb-client",
-  "version": "10.0.16",
+  "version": "10.0.17",
   "description": "TerminusDB client library",
   "main": "index.js",
   "types": "./dist/typescript/index.d.ts",