document makeClient function

collin · Aug 16, 2013 · 003e81a · 003e81a
1 parent 6dc8e91
commit 003e81a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/tasks/lib/s3.js b/tasks/lib/s3.js
@@ -76,6 +76,12 @@ exports.init = function (grunt) {
     return options;
   };
 
+  /**
+   * Create an s3 client. Returns an Knox instance.
+   *
+   * @param {Object} Format.
+   * @returns {Object}
+   */
   var makeClient = exports.makeClient = function(options) {
     return knox.createClient(_.pick(options, [
       'region', 'endpoint', 'port', 'key', 'secret', 'access', 'bucket', 'secure', 'headers', 'style'