From 0991dfceceede0b0ad47abf866e571dd5164d231 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 19 Sep 2021 17:18:42 -0700 Subject: [PATCH] doc: add blank line between comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Upcoming remark-based formatting/linting will add a blank line between comments in markdown. This is in preparation for that change. PR-URL: https://github.com/nodejs/node/pull/40160 Reviewed-By: Michaël Zasso Reviewed-By: Antoine du Hamel Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/api/addons.md | 1 + doc/api/cli.md | 1 + doc/api/corepack.md | 1 + doc/api/deprecations.md | 1 + doc/api/documentation.md | 2 ++ doc/api/errors.md | 1 + doc/api/esm.md | 2 ++ doc/api/globals.md | 1 + doc/api/intl.md | 1 + doc/api/module.md | 1 + doc/api/modules.md | 2 ++ doc/api/n-api.md | 1 + doc/api/net.md | 1 + doc/api/packages.md | 2 ++ doc/api/policy.md | 1 + doc/api/process.md | 2 ++ doc/api/report.md | 1 + doc/api/synopsis.md | 1 + doc/changelogs/CHANGELOG_ARCHIVE.md | 4 +--- doc/changelogs/CHANGELOG_IOJS.md | 4 +--- doc/changelogs/CHANGELOG_V010.md | 4 +--- doc/changelogs/CHANGELOG_V012.md | 4 +--- doc/changelogs/CHANGELOG_V10.md | 4 +--- doc/changelogs/CHANGELOG_V11.md | 4 +--- doc/changelogs/CHANGELOG_V12.md | 4 +--- doc/changelogs/CHANGELOG_V13.md | 4 +--- doc/changelogs/CHANGELOG_V14.md | 4 +--- doc/changelogs/CHANGELOG_V15.md | 4 +--- doc/changelogs/CHANGELOG_V16.md | 4 +--- doc/changelogs/CHANGELOG_V4.md | 4 +--- doc/changelogs/CHANGELOG_V5.md | 4 +--- doc/changelogs/CHANGELOG_V6.md | 4 +--- doc/changelogs/CHANGELOG_V7.md | 4 +--- doc/changelogs/CHANGELOG_V8.md | 4 +--- doc/changelogs/CHANGELOG_V9.md | 4 +--- 35 files changed, 40 insertions(+), 51 deletions(-) diff --git a/doc/api/addons.md b/doc/api/addons.md index 78814a97bba594..a906306b2cd1bc 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1,6 +1,7 @@ # C++ addons + _Addons_ are dynamically-linked shared objects written in C++. The diff --git a/doc/api/cli.md b/doc/api/cli.md index dc0f813a8468d0..c0a1859723ed33 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -1,6 +1,7 @@ # Command-line options + Node.js comes with a variety of CLI options. These options expose built-in diff --git a/doc/api/corepack.md b/doc/api/corepack.md index f5ee64e5158e10..fc6e2ab15e81e4 100644 --- a/doc/api/corepack.md +++ b/doc/api/corepack.md @@ -1,6 +1,7 @@ # Corepack + > Stability: 1 - Experimental diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index d1ed3a23c26d7a..593413efc01663 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -1,6 +1,7 @@ # Deprecated APIs + Node.js APIs might be deprecated for any of the following reasons: diff --git a/doc/api/documentation.md b/doc/api/documentation.md index a7747d91c16ee3..9100354b361644 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -1,6 +1,7 @@ # About this documentation + Welcome to the official API reference documentation for Node.js! @@ -51,6 +52,7 @@ a command-line flag. Experimental features may also emit a [warning][]. ## Stability overview + ## JSON output diff --git a/doc/api/errors.md b/doc/api/errors.md index a03b1f6fc2572a..f834aa699ab3df 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1,6 +1,7 @@ # Errors + Applications running in Node.js will generally experience four categories of diff --git a/doc/api/esm.md b/doc/api/esm.md index 2ad2e690ae9edc..e8afc730b43f47 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -1,7 +1,9 @@ # Modules: ECMAScript modules + + + These objects are available in all modules. The following variables may appear diff --git a/doc/api/intl.md b/doc/api/intl.md index 87935289d39183..716047a7c39c9a 100644 --- a/doc/api/intl.md +++ b/doc/api/intl.md @@ -1,6 +1,7 @@ # Internationalization support + Node.js has many features that make it easier to write internationalized diff --git a/doc/api/module.md b/doc/api/module.md index 0079d726c3ce7c..519240841a644f 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -1,6 +1,7 @@ # Modules: `module` API + diff --git a/doc/api/modules.md b/doc/api/modules.md index b3f62e078b4091..ee5d7eca65209c 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -280,6 +280,7 @@ irrespective of whether or not `./foo` and `./FOO` are the same file. ## Core modules + + * {Object} diff --git a/doc/api/n-api.md b/doc/api/n-api.md index b8b389a2ba6f7a..6a32139283f4aa 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1,6 +1,7 @@ # Node-API + > Stability: 2 - Stable diff --git a/doc/api/net.md b/doc/api/net.md index d06622f90b7f6e..1b662f0502f1bc 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -1,6 +1,7 @@ # Net + > Stability: 2 - Stable diff --git a/doc/api/packages.md b/doc/api/packages.md index 4aee6b77ecbe11..e584eaf182bc28 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -1,7 +1,9 @@ # Modules: Packages + + + > Stability: 1 - Experimental diff --git a/doc/api/process.md b/doc/api/process.md index f2b7ac8f99b05c..67a6c6ce0f1f41 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1,6 +1,7 @@ # Process + @@ -665,6 +666,7 @@ A few of the warning types that are most common include: ### Signal events + Signal events will be emitted when the Node.js process receives a signal. Please diff --git a/doc/api/report.md b/doc/api/report.md index accf3ca21044fd..a050e2c006f216 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -1,6 +1,7 @@ # Diagnostic report + > Stability: 2 - Stable diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 2bbf53cdec4967..5bfdebc32c6c1b 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -3,6 +3,7 @@ ## Usage + `node [options] [V8 options] [script.js | -e "script" | - ] [arguments]` diff --git a/doc/changelogs/CHANGELOG_ARCHIVE.md b/doc/changelogs/CHANGELOG_ARCHIVE.md index 4914d45b955754..eb6759df6a954f 100644 --- a/doc/changelogs/CHANGELOG_ARCHIVE.md +++ b/doc/changelogs/CHANGELOG_ARCHIVE.md @@ -1,8 +1,6 @@ # Node.js ChangeLog Archive - - - + diff --git a/doc/changelogs/CHANGELOG_IOJS.md b/doc/changelogs/CHANGELOG_IOJS.md index cb6832ab574e1b..1760c92a9c7202 100644 --- a/doc/changelogs/CHANGELOG_IOJS.md +++ b/doc/changelogs/CHANGELOG_IOJS.md @@ -1,8 +1,6 @@ # io.js ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V010.md b/doc/changelogs/CHANGELOG_V010.md index 5d375fa17ffba3..461e1b8b9602c2 100644 --- a/doc/changelogs/CHANGELOG_V010.md +++ b/doc/changelogs/CHANGELOG_V010.md @@ -1,8 +1,6 @@ # Node.js 0.10 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V012.md b/doc/changelogs/CHANGELOG_V012.md index 8cfe45a7d48a33..a5b25427a3ab48 100644 --- a/doc/changelogs/CHANGELOG_V012.md +++ b/doc/changelogs/CHANGELOG_V012.md @@ -1,8 +1,6 @@ # Node.js 0.12 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V10.md b/doc/changelogs/CHANGELOG_V10.md index 21711f018e2151..d67acd69004caa 100644 --- a/doc/changelogs/CHANGELOG_V10.md +++ b/doc/changelogs/CHANGELOG_V10.md @@ -1,8 +1,6 @@ # Node.js 10 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V11.md b/doc/changelogs/CHANGELOG_V11.md index 8ff4527f81f9f8..67e1c106734e42 100644 --- a/doc/changelogs/CHANGELOG_V11.md +++ b/doc/changelogs/CHANGELOG_V11.md @@ -1,8 +1,6 @@ # Node.js 11 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V12.md b/doc/changelogs/CHANGELOG_V12.md index 01887997cf953f..78113f37bada7b 100644 --- a/doc/changelogs/CHANGELOG_V12.md +++ b/doc/changelogs/CHANGELOG_V12.md @@ -1,8 +1,6 @@ # Node.js 12 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V13.md b/doc/changelogs/CHANGELOG_V13.md index 412824b14d2f65..5241cc3461c2e8 100644 --- a/doc/changelogs/CHANGELOG_V13.md +++ b/doc/changelogs/CHANGELOG_V13.md @@ -1,8 +1,6 @@ # Node.js 13 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V14.md b/doc/changelogs/CHANGELOG_V14.md index 1af9d1fb427d5c..d400a02b388a92 100644 --- a/doc/changelogs/CHANGELOG_V14.md +++ b/doc/changelogs/CHANGELOG_V14.md @@ -1,8 +1,6 @@ # Node.js 14 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V15.md b/doc/changelogs/CHANGELOG_V15.md index 1855da132b18f6..d394bf08fc0a30 100644 --- a/doc/changelogs/CHANGELOG_V15.md +++ b/doc/changelogs/CHANGELOG_V15.md @@ -1,8 +1,6 @@ # Node.js 15 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V16.md b/doc/changelogs/CHANGELOG_V16.md index 128467175d01df..e25af45739d73c 100644 --- a/doc/changelogs/CHANGELOG_V16.md +++ b/doc/changelogs/CHANGELOG_V16.md @@ -1,8 +1,6 @@ # Node.js 16 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md index 089bc23f9d5125..757420beda9d9a 100644 --- a/doc/changelogs/CHANGELOG_V4.md +++ b/doc/changelogs/CHANGELOG_V4.md @@ -1,8 +1,6 @@ # Node.js 4 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md index 79c92d09418fca..52dabcb46c353e 100644 --- a/doc/changelogs/CHANGELOG_V5.md +++ b/doc/changelogs/CHANGELOG_V5.md @@ -1,8 +1,6 @@ # Node.js 5 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md index 68d243d03f6707..1ed801efc0d793 100644 --- a/doc/changelogs/CHANGELOG_V6.md +++ b/doc/changelogs/CHANGELOG_V6.md @@ -1,8 +1,6 @@ # Node.js 6 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V7.md b/doc/changelogs/CHANGELOG_V7.md index 9f5581129c1fc6..d32d2451ff4505 100644 --- a/doc/changelogs/CHANGELOG_V7.md +++ b/doc/changelogs/CHANGELOG_V7.md @@ -1,8 +1,6 @@ # Node.js 7 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V8.md b/doc/changelogs/CHANGELOG_V8.md index f64372f41b44e3..ab474c998259db 100644 --- a/doc/changelogs/CHANGELOG_V8.md +++ b/doc/changelogs/CHANGELOG_V8.md @@ -1,8 +1,6 @@ # Node.js 8 ChangeLog - - - +
diff --git a/doc/changelogs/CHANGELOG_V9.md b/doc/changelogs/CHANGELOG_V9.md index 6721296dd422d9..c08ea38714ecf9 100644 --- a/doc/changelogs/CHANGELOG_V9.md +++ b/doc/changelogs/CHANGELOG_V9.md @@ -1,8 +1,6 @@ # Node.js 9 ChangeLog - - - +