fix doc

Madadata · Feb 14, 2017 · c1c5cbe · c1c5cbe
1 parent faedc8e
commit c1c5cbe
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,3 +43,4 @@ test/test_flow.js
 dist
 test/s3test.js
 doc/
+.DS_Store
diff --git a/src/index.js b/src/index.js
@@ -31,11 +31,11 @@ export default class Hasoop {
 
   /**
    * use some param to create a sqoop rest api url.
-   *
-   * @param basicPath
-   * @param queryObject
-   * @param otherPath
-   * @returns {*}
+   * @param {Array} pathAndQuery - path and query
+   * @param {string} pathAndQuery[0] - basicPath
+   * @param {Object} pathAndQuery[1] - queryObject
+   * @param {Array<string>} otherPath - other paths
+   * @returns {urlObject} - formatted url object
    */
   formatUrl ([basicPath, queryObject = {}], ...otherPath) {
     _.set(queryObject, ['user.name'], this.userName)