github-api-promise - npm Package Compare versions

Comparing version 1.6.0 to 1.8.0

package.json

 {
   "name": "github-api-promise",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "A node module for interfacing with the Github API using promises",
@@ -20,3 +20,9 @@ "main": "src/app.js",
     "urlencode": "^1.1.0"
+  },
+  "devDependencies": {
+    "docdash": "^0.4.0"
+  },
+  "scripts": {
+  	"generate-docs": "jsdoc -r -c jsdoc.json -R README.md"
   }
 }

README.md

@@ -5,2 +5,3 @@ # github-api-promise
 
+
 # Installation
@@ -12,2 +13,8 @@
 
+
+# Documentation
+
+https://princenebulon.github.io/github-api-promise/
+
+
 # Usage
@@ -44,2 +51,3 @@
 
+
 # API Support
@@ -61,6 +69,3 @@
 
-# Documentation
 
-TODO: JSDoc on github pages. For now, browse the module's source and read the JSDoc comments.
-
 # Thanks
@@ -67,0 +72,0 @@

src/activity/events.js

@@ -5,3 +5,5 @@ const config = require('../config');
 
-
+/**
+ * @module activity/events
+ */
 module.exports = {
@@ -8,0 +10,0 @@ /**

src/app.js

@@ -17,2 +17,3 @@ var githubApi = {};
 githubApi.pullRequests = {
+	comments: require('./pull-requests/comments'),
 	pullRequests: require('./pull-requests/pull-requests')
@@ -22,2 +23,3 @@ };
 githubApi.repositories = {
+	commits: require('./repositories/commits'),
 	releases: require('./repositories/releases'),
@@ -24,0 +26,0 @@ repositories: require('./repositories/repositories')

src/issues/comments.js

@@ -6,2 +6,5 @@ const config = require('../config');
 
+/**
+ * @module issues/comments
+ */
 module.exports = {
@@ -8,0 +11,0 @@

src/issues/events.js

@@ -6,2 +6,5 @@ const config = require('../config');
 
+/**
+ * @module issues/events
+ */
 module.exports = {
@@ -8,0 +11,0 @@

src/issues/issues.js

@@ -6,2 +6,5 @@ const config = require('../config');
 
+/**
+ * @module issues/issues
+ */
 module.exports = {
@@ -125,2 +128,3 @@
 	 * @param {string}   repo           - The repo's name
+	 * @param {object}   body           - The request body
 	 * @param {string}   body.title     - Required. The title of the issue.
@@ -148,2 +152,3 @@ * @param {string}   body.body      - The contents of the issue.
 	 * @param {string}   number         - The issue id
+	 * @param {object}   body           - The request body
 	 * @param {string}   body.title     - Required. The title of the issue.
@@ -150,0 +155,0 @@ * @param {string}   body.body      - The contents of the issue.

src/pull-requests/pull-requests.js

@@ -5,3 +5,6 @@ const config = require('../config');
 
-
+/**
+ * Pull Requests module
+ * @module pullRequests/pullRequests
+ */
 module.exports = {
@@ -38,3 +41,3 @@
 	 * @param {string} repo   - The repo's name
-	 * @param {string} number - The pull request's ID
+	 * @param {string} number - The pull request number
 	 *
@@ -74,3 +77,3 @@ * @return {object} Pull request data
 	 * @param {string}  repo                       - The repo's name
-	 * @param {string}  number                     - The pull request ID
+	 * @param {string}  number                     - The pull request number
 	 * @param {object}  body                       - The request body
@@ -96,3 +99,3 @@ * @param {string}  body.title                 - Required. The title of the pull request.
 	 * @param {string} repo        - The repo's name
-	 * @param {string} number      - The pull request ID
+	 * @param {string} number      - The pull request number
 	 * @param {object} params      - An object of parameters for the request
@@ -115,3 +118,3 @@ * @param {int}    params.page - The page of results to retrieve
 	 * @param {string} repo        - The repo's name
-	 * @param {string} number      - The pull request ID
+	 * @param {string} number      - The pull request number
 	 * @param {object} params      - An object of parameters for the request
@@ -134,3 +137,3 @@ * @param {int}    params.page - The page of results to retrieve
 	 * @param {string} repo   - The repo's name
-	 * @param {string} number - The pull request ID
+	 * @param {string} number - The pull request number
 	 *
@@ -146,7 +149,8 @@ * @return {null} 204=merged / 404=not merged
 	 * 
-	 * @see {@link https://developer.github.com/v3/pulls#}
+	 * @see {@link https://developer.github.com/v3/pulls#merge-a-pull-request-merge-button}
 	 * 
 	 * @param {string} owner                 - The repo's owner
 	 * @param {string} repo                  - The repo's name
-	 * @param {object} params                - An object of parameters for the request * @param {string} params.commit_title	 - Title for the automatic commit message.
+	 * @param {object} params                - An object of parameters for the request
+	 * @param {string} params.commit_title   - Title for the automatic commit message.
 	 * @param {string} params.commit_message - Extra detail to append to automatic commit message.
@@ -153,0 +157,0 @@ * @param {string} params.sha            - SHA that pull request head must match to allow merge.

src/repositories/releases.js

@@ -33,2 +33,5 @@ var request = require('superagent-bluebird-promise');
 
+/**
+ * @module repositories/releases
+ */
 module.exports = {
@@ -35,0 +38,0 @@ /**

src/repositories/repositories.js

@@ -5,3 +5,5 @@ const config = require('../config');
 
-
+/**
+ * @module repositories/repositories
+ */
 module.exports = {
@@ -8,0 +10,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

69707

increased by9.74%

Number of package files

15

increased by15.38%

Lines of code

1484

increased by10.5%

Number of lines in readme file

72

increased by7.46%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes