Skip to content

Commit e611ef9

Browse files
committed
Merge pull request #2 from danzajdband/fix-constructors-docstrings
Docs: Fixed constructors docstrings.
2 parents 24dfcee + c1ff0bc commit e611ef9

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

lib/index.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ module.exports = Mango;
2626
/**
2727
* Mango constructor
2828
*
29-
* @param {String} api_key
29+
* @param {Object} options
30+
* @param {String} options.api_key - Mango Secret API Key
3031
* @return {Mango} API client instance
3132
* @api public
3233
*/

lib/resources/index.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ var BASE_URL = "https://api.getmango.com/v1";
1111

1212
/**
1313
* Resource constructor
14+
*
15+
* @param {Mango} mango
1416
*/
1517

1618
function Resource(mango) {

0 commit comments

Comments
 (0)