Refactor comments

Author: wooorm

lib/any.js

@@ -110,7 +110,7 @@ function collector(one) {
 
   return collect
 
-  /* Append elements to array, filtering out duplicates. */
+  // Append elements to array, filtering out duplicates.
   function collect(source) {
     if ('length' in source) {
       collectAll()

lib/attribute.js

@@ -39,12 +39,12 @@ function match(query, node, schema) {
   return true
 }
 
-/* [attr] */
+// `[attr]`
 function exists(query, node, info) {
   return has(node, info.property)
 }
 
-/* [attr=value] */
+// `[attr=value]`
 function exact(query, node, info) {
   if (!has(node, info.property)) {
     return false
@@ -53,7 +53,7 @@ function exact(query, node, info) {
   return normalizeValue(node.properties[info.property], info) === query.value
 }
 
-/* [attr~=value] */
+// `[attr~=value]`
 function spaceSeparatedList(query, node, info) {
   var val
 
@@ -63,8 +63,8 @@ function spaceSeparatedList(query, node, info) {
 
   val = node.properties[info.property]
 
-  /* If this is a comma-separated list, and the query is contained in it,
-   * return true. */
+  // If this is a comma-separated list, and the query is contained in it, return
+  // true.
   if (
     typeof val === 'object' &&
     !info.commaSeparated &&
@@ -73,12 +73,12 @@ function spaceSeparatedList(query, node, info) {
     return true
   }
 
-  /* For all other values (including comma-separated lists),
-   * return whether this is an exact match. */
+  // For all other values (including comma-separated lists), return whether this
+  // is an exact match.
   return normalizeValue(val, info) === query.value
 }
 
-/* [attr|=value] */
+// `[attr|=value]`
 function exactOrPrefix(query, node, info) {
   var value
 
@@ -95,7 +95,7 @@ function exactOrPrefix(query, node, info) {
   )
 }
 
-/* [attr^=value] */
+// `[attr^=value]`
 function begins(query, node, info) {
   var value
 
@@ -108,7 +108,7 @@ function begins(query, node, info) {
   return value.slice(0, query.value.length) === query.value
 }
 
-/* [attr$=value] */
+// `[attr$=value]`
 function ends(query, node, info) {
   if (!has(node, info.property)) {
     return false
@@ -121,7 +121,7 @@ function ends(query, node, info) {
   )
 }
 
-/* [attr*=value] */
+// `[attr*=value]`
 function contains(query, node, info) {
   if (!has(node, info.property)) {
     return false
@@ -139,7 +139,7 @@ function unknownOperator(query) {
   throw new Error('Unknown operator `' + query.operator + '`')
 }
 
-/* Stringify a hast value back to its HTML form. */
+// Stringify a hast value back to its HTML form.
 function normalizeValue(value, info) {
   if (typeof value === 'number') {
     value = String(value)

lib/enter-state.js

@@ -57,29 +57,29 @@ function enter(state, node) {
         found = true
       }
 
-      // See: https://html.spec.whatwg.org/#the-directionality
-      // Explicit `[dir=rtl]`
+      // See: <https://html.spec.whatwg.org/#the-directionality>.
+      // Explicit `[dir=rtl]`.
       if (dir === rtl) {
         dirInferred = dir
       } else if (
-        // Explicit `[dir=ltr]`
+        // Explicit `[dir=ltr]`.
         dir === ltr ||
-        // HTML with an invalid or no `[dir]`
+        // HTML with an invalid or no `[dir]`.
         (dir !== auto && is(node, 'html')) ||
-        // `input[type=tel]` with an invalid or no `[dir]`
+        // `input[type=tel]` with an invalid or no `[dir]`.
         (dir !== auto && is(node, 'input') && props.type === 'tel')
       ) {
         dirInferred = ltr
-        // `[dir=auto]` or `bdi` with an invalid or no `[dir]`
+        // `[dir=auto]` or `bdi` with an invalid or no `[dir]`.
       } else if (dir === auto || is(node, 'bdi')) {
         if (is(node, 'textarea')) {
-          // Check contents of textarea
+          // Check contents of `<textarea>`.
           dirInferred = dirBidi(toString(node))
         } else if (is(node, 'input') && valueTypes.indexOf(type) !== -1) {
-          // Check value of input
+          // Check value of `<input>`.
           dirInferred = props.value ? dirBidi(props.value) : ltr
         } else {
-          // Check text nodes in `node`
+          // Check text nodes in `node`.
           visit(node, inferDirectionality)
         }
       }

lib/nest.js

@@ -12,8 +12,8 @@ var handle = zwitch('nestingOperator')
 var handlers = handle.handlers
 
 handle.unknown = unknownNesting
-handle.invalid = topScan /* `undefined` is the top query selector. */
-handlers.null = descendant /* `null` is the descendant combinator. */
+handle.invalid = topScan // `undefined` is the top query selector.
+handlers.null = descendant // `null` is the descendant combinator.
 handlers['>'] = child
 handlers['+'] = adjacentSibling
 handlers['~'] = generalSibling
@@ -95,7 +95,7 @@ function generalSibling(query, node, index, parent, state) {
     .done()
 }
 
-/* Handles typeIndex and typeCount properties for every walker. */
+// Handles `typeIndex` and `typeCount` properties for every walker.
 function walkIterator(query, parent, state) {
   var nodes = parent.children
   var typeIndex = state.index ? createTypeIndex() : null
@@ -150,7 +150,7 @@ function walkIterator(query, parent, state) {
       pushNode()
     }
 
-    /* Stop if we’re looking for one node and it’s already found. */
+    // Stop if we’re looking for one node and it’s already found.
     if (state.one && state.found) {
       return this
     }
@@ -210,7 +210,7 @@ function createTypeIndex() {
       counts[type] = 0
     }
 
-    /* Note: ++ needs is intended to be postfixed! */
+    // Note: ++ needs is intended to be postfixed!
     return counts[type]++
   }
 

test/matches.js

@@ -858,7 +858,10 @@ test('select.matches()', function(t) {
       sst.ok(matches('a:has(img )', h('a', h('img'))), 'assertion (#3)')
       sst.ok(matches('a:has( img  ,\t p )', h('a', h('img'))), 'assertion (#4)')
 
-      // Sst.ok(
+      // Note: These should be unquoted, but that’s not supported by the CSS
+      // parser:
+      //
+      // sst.ok(
       //   matches('a:has(> img)', h('a', h('img'))),
       //   'true for relative direct child selector'
       // )
@@ -871,8 +874,6 @@ test('select.matches()', function(t) {
       //   'should support a list of relative selectors'
       // )
 
-      // Note: These should be unquoted, but that’s not supported by the CSS parser.
-
       sst.end()
     })
 
@@ -1092,6 +1093,7 @@ test('select.matches()', function(t) {
       )
 
       // Not supported by `css-selector-parser` yet :(
+      //
       // sst.ok(
       //   matches(':lang("fr-BE", "de-*-DE")', h('html', {lang: 'de-Latn-DE'})),
       //   'should support non-primary wildcard subtags (#2)'