Refactor comments

lib/handlers/footnote.js

@@ -15,7 +15,8 @@ function footnote(h, node) {
 
   identifier = String(identifier)
 
-  // No need to check if `identifier` exists, as it’s guaranteed to not exist.
+  // No need to check if `identifier` exists in `footnoteOrder`, it’s guaranteed
+  // to not exist because we just generated it.
   footnoteOrder.push(identifier)
 
   footnoteById[identifier] = {

lib/handlers/html.js

@@ -4,7 +4,7 @@ module.exports = html
 
 var u = require('unist-builder')
 
-// Return either a `raw` node, in dangerous mode, or nothing.
+// Return either a `raw` node in dangerous mode, otherwise nothing.
 function html(h, node) {
   return h.dangerous ? h.augment(node, u('raw', node.value)) : null
 }

lib/handlers/index.js

@@ -29,7 +29,7 @@ module.exports = {
   footnoteDefinition: ignore
 }
 
-// Return nothing for nodes which are ignored.
+// Return nothing for nodes that are ignored.
 function ignore() {
   return null
 }

lib/handlers/list-item.js

@@ -18,7 +18,7 @@ function listItem(h, node, parent) {
   var length
   var child
 
-  /* Tight lists should not render 'paragraph' nodes as 'p' tags */
+  // Tight lists should not render `paragraph` nodes as `p` elements.
   if (loose) {
     result = raw
   } else {
@@ -57,6 +57,7 @@ function listItem(h, node, parent) {
     )
 
     // According to github-markdown-css, this class hides bullet.
+    // See: <https://github.com/sindresorhus/github-markdown-css>.
     props.className = ['task-list-item']
   }
 

lib/handlers/list.js

@@ -19,7 +19,7 @@ function list(h, node) {
   items = all(h, node)
   length = items.length
 
-  // Like GitHub, add a class for custom styling
+  // Like GitHub, add a class for custom styling.
   while (++index < length) {
     if (
       items[index].properties.className &&

lib/index.js

@@ -36,7 +36,7 @@ function factory(tree, options) {
     var data
     var ctx
 
-    // Handle `data.hName`, `data.hProperties, `hChildren`.
+    // Handle `data.hName`, `data.hProperties, `data.hChildren`.
     if (left && 'data' in left) {
       data = left.data
 
@@ -65,7 +65,7 @@ function factory(tree, options) {
     return right
   }
 
-  // Create an element for a `node`.
+  // Create an element for `node`.
   function h(node, tagName, props, children) {
     if (
       (children === undefined || children === null) &&
@@ -88,7 +88,7 @@ function factory(tree, options) {
     var id = definition.identifier.toUpperCase()
 
     // Mimick CM behavior of link definitions.
-    // https://github.com/syntax-tree/mdast-util-definitions/blob/8d48e57/index.js#L26
+    // See: <https://github.com/syntax-tree/mdast-util-definitions/blob/8d48e57/index.js#L26>.
     if (!own.call(footnoteById, id)) {
       footnoteById[id] = definition
     }

lib/one.js

@@ -29,7 +29,7 @@ function one(h, node, parent) {
   return (typeof fn === 'function' ? fn : unknown)(h, node, parent)
 }
 
-// Check if the node should be renderered a text node.
+// Check if the node should be renderered as a text node.
 function text(node) {
   var data = node.data || {}
 

lib/revert.js

@@ -5,7 +5,7 @@ module.exports = revert
 var u = require('unist-builder')
 var all = require('./all')
 
-// Return the content of a reference without definition as markdown.
+// Return the content of a reference without definition as Markdown.
 function revert(h, node) {
   var subtype = node.referenceType
   var suffix = ']'

lib/wrap.js

@@ -4,8 +4,8 @@ module.exports = wrap
 
 var u = require('unist-builder')
 
-// Wrap `nodes` with newlines between each entry.  Optionally adds newlines at
-// the start and end.
+// Wrap `nodes` with line feeds between each entry.
+// Optionally adds line feeds at the start and end.
 function wrap(nodes, loose) {
   var result = []
   var index = -1