doc: add few comment

loopbackio · Nov 19, 2019 · 7770c30 · 7770c30
1 parent eef9b60
commit 7770c30
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docker.setup.js b/docker.setup.js
@@ -19,7 +19,7 @@ const async = require('async');
 const docker = new require('dockerode')();
 const http = require('http');
 const ms = require('ms');
-const fs = require('fs-extra');
+const fs = require('fs');
 
 process.env.CLOUDANT_DATABASE = 'testdb';
 process.env.CLOUDANT_PASSWORD = 'pass';

diff --git a/lib/cloudant.js b/lib/cloudant.js
@@ -135,12 +135,15 @@ Cloudant.prototype.ping = function(cb) {
 };
 
 /**
- *  Apply find queries function
+ *  Apply find queries function.
+ *  This function will perform a partitionedFind if `partitionKey`
+ *  is provided in the options or from the query(to be supported).
  *
  * @param {Object} mo The selected model
  * @param {Object} query The query to filter
  * @param {Object[]} docs Model document/data
  * @param {Object} include Include filter
+ * @param {Object} options Options for find method, like `partitionKey`
  * @callback {Function} cb The callback function
  */
 Cloudant.prototype._findRecursive = function(