Inline method

tmcw · tmcw · commit 21371e71da30 · 2016-06-02T13:28:57.000-04:00
diff --git a/lib/github.js b/lib/github.js
@@ -4,10 +4,6 @@ var path = require('path');
 var findGit = require('../lib/git/find_git');
 var getGithubURLPrefix = require('../lib/git/url_prefix');
 
-function getFileRoot(file) {
-  return path.dirname(findGit(file));
-}
-
 /**
  * Attempts to link code to its place on GitHub.
  *
@@ -16,7 +12,7 @@ function getFileRoot(file) {
  * @return {Object} comment with github inferred
  */
 module.exports = function (comment) {
-  var root = getFileRoot(comment.context.file);
+  var root = path.dirname(findGit(comment.context.file));
   var urlPrefix = getGithubURLPrefix(root);
   var fileRelativePath = comment.context.file.replace(root + path.sep, '')
     .split(path.sep)
diff --git a/lib/hierarchy.js b/lib/hierarchy.js
@@ -5,7 +5,7 @@ var hasOwnProperty = Object.prototype.hasOwnProperty;
 /**
  * Pick only relevant properties from a comment to store them in
  * an inheritance chain
- * @param {Object} comment
+ * @param {Object} comment a parsed comment
  * @returns {Object} reduced comment
  * @private
  */
diff --git a/lib/parse.js b/lib/parse.js
@@ -320,6 +320,7 @@ function flattenMarkdownDescription(result, tag, key) {
  * @param {Object} result comment
  * @param {Object} tag parsed tag
  * @param {string} key tag
+ * @returns {undefined} operates through side effects
  * @private
  */
 function flattenKindShorthand(result, tag, key) {
