Refactor code-style

micromark · Jun 27, 2023 · 7513e41 · 7513e41
1 parent 6ea57a7
commit 7513e41
Show file tree

Hide file tree

Showing 4 changed files with 338 additions and 256 deletions.
diff --git a/dev/lib/html.js b/dev/lib/html.js
@@ -16,7 +16,7 @@ import {matters} from '../matters.js'
  * > frontmatter.
  *
  * @param {Options | null | undefined} [options='yaml']
- *   Configuration.
+ *   Configuration (default: `'yaml'`).
  * @returns {HtmlExtension}
  *   Extension for `micromark` that can be passed in `htmlExtensions`, to
  *   support frontmatter when serializing to HTML.

diff --git a/dev/lib/syntax.js b/dev/lib/syntax.js
@@ -391,7 +391,7 @@ function createConstruct(matter) {
 
 /**
  * @param {Matter} matter
- * @param {'open' | 'close'} prop
+ * @param {'close' | 'open'} prop
  * @returns {string}
  */
 function fence(matter, prop) {
@@ -403,7 +403,7 @@ function fence(matter, prop) {
 
 /**
  * @param {Info | string} schema
- * @param {'open' | 'close'} prop
+ * @param {'close' | 'open'} prop
  * @returns {string}
  */
 function pick(schema, prop) {

diff --git a/dev/matters.js b/dev/matters.js
@@ -6,10 +6,10 @@
  *   Sequence.
  *
  *   Depending on how this structure is used, it reflects a marker or a fence.
- * @property {string} open
- *   Opening.
  * @property {string} close
  *   Closing.
+ * @property {string} open
+ *   Opening.
  *
  * @typedef MatterProps
  *   Fields describing a kind of matter.
@@ -70,7 +70,7 @@ const markers = {yaml: '-', toml: '+'}
  * Simplify one or more options.
  *
  * @param {Options | null | undefined} [options='yaml']
- *   Configuration.
+ *   Configuration (default: `'yaml'`).
  * @returns {Array<Matter>}
  *   List of matters.
  */