diff options
author | Rich Trott <rtrott@gmail.com> | 2021-09-20 03:18:42 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2021-09-22 04:40:04 +0300 |
commit | 0991dfceceede0b0ad47abf866e571dd5164d231 (patch) | |
tree | fd1f291a692a229b1cb4e2acd322fcde5de837f8 | |
parent | 5ca5499c8787da1dbe1f5535a198dbdc2289a866 (diff) |
doc: add blank line between comments
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 <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
35 files changed, 40 insertions, 51 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md index 78814a97bba..a906306b2cd 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1,6 +1,7 @@ # C++ addons <!--introduced_in=v0.10.0--> + <!-- type=misc --> _Addons_ are dynamically-linked shared objects written in C++. The diff --git a/doc/api/cli.md b/doc/api/cli.md index dc0f813a846..c0a1859723e 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -1,6 +1,7 @@ # Command-line options <!--introduced_in=v5.9.1--> + <!--type=misc--> 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 f5ee64e5158..fc6e2ab15e8 100644 --- a/doc/api/corepack.md +++ b/doc/api/corepack.md @@ -1,6 +1,7 @@ # Corepack <!-- introduced_in=v16.9.0 --> + <!-- type=misc --> > Stability: 1 - Experimental diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index d1ed3a23c26..593413efc01 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -1,6 +1,7 @@ # Deprecated APIs <!--introduced_in=v7.7.0--> + <!-- type=misc --> 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 a7747d91c16..9100354b361 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -1,6 +1,7 @@ # About this documentation <!--introduced_in=v0.10.0--> + <!-- type=misc --> 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 <!-- STABILITY_OVERVIEW_SLOT_BEGIN --> + <!-- STABILITY_OVERVIEW_SLOT_END --> ## JSON output diff --git a/doc/api/errors.md b/doc/api/errors.md index a03b1f6fc25..f834aa699ab 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1,6 +1,7 @@ # Errors <!--introduced_in=v4.0.0--> + <!--type=misc--> Applications running in Node.js will generally experience four categories of diff --git a/doc/api/esm.md b/doc/api/esm.md index 2ad2e690ae9..e8afc730b43 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -1,7 +1,9 @@ # Modules: ECMAScript modules <!--introduced_in=v8.5.0--> + <!-- type=misc --> + <!-- YAML added: v8.5.0 changes: diff --git a/doc/api/globals.md b/doc/api/globals.md index 79f0932b181..701ab79d57b 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -1,6 +1,7 @@ # Global objects <!--introduced_in=v0.10.0--> + <!-- type=misc --> 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 87935289d39..716047a7c39 100644 --- a/doc/api/intl.md +++ b/doc/api/intl.md @@ -1,6 +1,7 @@ # Internationalization support <!--introduced_in=v8.2.0--> + <!-- type=misc --> 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 0079d726c3c..519240841a6 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -1,6 +1,7 @@ # Modules: `module` API <!--introduced_in=v12.20.0--> + <!-- YAML added: v0.3.7 --> diff --git a/doc/api/modules.md b/doc/api/modules.md index b3f62e078b4..ee5d7eca652 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 <!--type=misc--> + <!-- YAML changes: - version: v16.0.0 @@ -773,6 +774,7 @@ added: v0.1.16 --> <!-- type=var --> + <!-- name=module --> * {Object} diff --git a/doc/api/n-api.md b/doc/api/n-api.md index b8b389a2ba6..6a32139283f 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1,6 +1,7 @@ # Node-API <!--introduced_in=v8.0.0--> + <!-- type=misc --> > Stability: 2 - Stable diff --git a/doc/api/net.md b/doc/api/net.md index d06622f90b7..1b662f0502f 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -1,6 +1,7 @@ # Net <!--introduced_in=v0.10.0--> + <!--lint disable maximum-line-length--> > Stability: 2 - Stable diff --git a/doc/api/packages.md b/doc/api/packages.md index 4aee6b77ecb..e584eaf182b 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -1,7 +1,9 @@ # Modules: Packages <!--introduced_in=v12.20.0--> + <!-- type=misc --> + <!-- YAML changes: - version: diff --git a/doc/api/policy.md b/doc/api/policy.md index 01b3eba0a33..0d53352788a 100644 --- a/doc/api/policy.md +++ b/doc/api/policy.md @@ -1,6 +1,7 @@ # Policies <!--introduced_in=v11.8.0--> + <!-- type=misc --> > Stability: 1 - Experimental diff --git a/doc/api/process.md b/doc/api/process.md index f2b7ac8f99b..67a6c6ce0f1 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1,6 +1,7 @@ # Process <!-- introduced_in=v0.10.0 --> + <!-- type=global --> <!-- source_link=lib/process.js --> @@ -665,6 +666,7 @@ A few of the warning types that are most common include: ### Signal events <!--type=event--> + <!--name=SIGINT, SIGHUP, etc.--> 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 accf3ca2104..a050e2c006f 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -1,6 +1,7 @@ # Diagnostic report <!--introduced_in=v11.8.0--> + <!-- type=misc --> > Stability: 2 - Stable diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 2bbf53cdec4..5bfdebc32c6 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -3,6 +3,7 @@ ## Usage <!--introduced_in=v0.10.0--> + <!--type=misc--> `node [options] [V8 options] [script.js | -e "script" | - ] [arguments]` diff --git a/doc/changelogs/CHANGELOG_ARCHIVE.md b/doc/changelogs/CHANGELOG_ARCHIVE.md index 4914d45b955..eb6759df6a9 100644 --- a/doc/changelogs/CHANGELOG_ARCHIVE.md +++ b/doc/changelogs/CHANGELOG_ARCHIVE.md @@ -1,8 +1,6 @@ # Node.js ChangeLog Archive -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_IOJS.md b/doc/changelogs/CHANGELOG_IOJS.md index cb6832ab574..1760c92a9c7 100644 --- a/doc/changelogs/CHANGELOG_IOJS.md +++ b/doc/changelogs/CHANGELOG_IOJS.md @@ -1,8 +1,6 @@ # io.js ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V010.md b/doc/changelogs/CHANGELOG_V010.md index 5d375fa17ff..461e1b8b960 100644 --- a/doc/changelogs/CHANGELOG_V010.md +++ b/doc/changelogs/CHANGELOG_V010.md @@ -1,8 +1,6 @@ # Node.js 0.10 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V012.md b/doc/changelogs/CHANGELOG_V012.md index 8cfe45a7d48..a5b25427a3a 100644 --- a/doc/changelogs/CHANGELOG_V012.md +++ b/doc/changelogs/CHANGELOG_V012.md @@ -1,8 +1,6 @@ # Node.js 0.12 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V10.md b/doc/changelogs/CHANGELOG_V10.md index 21711f018e2..d67acd69004 100644 --- a/doc/changelogs/CHANGELOG_V10.md +++ b/doc/changelogs/CHANGELOG_V10.md @@ -1,8 +1,6 @@ # Node.js 10 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V11.md b/doc/changelogs/CHANGELOG_V11.md index 8ff4527f81f..67e1c106734 100644 --- a/doc/changelogs/CHANGELOG_V11.md +++ b/doc/changelogs/CHANGELOG_V11.md @@ -1,8 +1,6 @@ # Node.js 11 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V12.md b/doc/changelogs/CHANGELOG_V12.md index 01887997cf9..78113f37bad 100644 --- a/doc/changelogs/CHANGELOG_V12.md +++ b/doc/changelogs/CHANGELOG_V12.md @@ -1,8 +1,6 @@ # Node.js 12 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V13.md b/doc/changelogs/CHANGELOG_V13.md index 412824b14d2..5241cc3461c 100644 --- a/doc/changelogs/CHANGELOG_V13.md +++ b/doc/changelogs/CHANGELOG_V13.md @@ -1,8 +1,6 @@ # Node.js 13 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V14.md b/doc/changelogs/CHANGELOG_V14.md index 1af9d1fb427..d400a02b388 100644 --- a/doc/changelogs/CHANGELOG_V14.md +++ b/doc/changelogs/CHANGELOG_V14.md @@ -1,8 +1,6 @@ # Node.js 14 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V15.md b/doc/changelogs/CHANGELOG_V15.md index 1855da132b1..d394bf08fc0 100644 --- a/doc/changelogs/CHANGELOG_V15.md +++ b/doc/changelogs/CHANGELOG_V15.md @@ -1,8 +1,6 @@ # Node.js 15 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V16.md b/doc/changelogs/CHANGELOG_V16.md index 128467175d0..e25af45739d 100644 --- a/doc/changelogs/CHANGELOG_V16.md +++ b/doc/changelogs/CHANGELOG_V16.md @@ -1,8 +1,6 @@ # Node.js 16 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md index 089bc23f9d5..757420beda9 100644 --- a/doc/changelogs/CHANGELOG_V4.md +++ b/doc/changelogs/CHANGELOG_V4.md @@ -1,8 +1,6 @@ # Node.js 4 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md index 79c92d09418..52dabcb46c3 100644 --- a/doc/changelogs/CHANGELOG_V5.md +++ b/doc/changelogs/CHANGELOG_V5.md @@ -1,8 +1,6 @@ # Node.js 5 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md index 68d243d03f6..1ed801efc0d 100644 --- a/doc/changelogs/CHANGELOG_V6.md +++ b/doc/changelogs/CHANGELOG_V6.md @@ -1,8 +1,6 @@ # Node.js 6 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V7.md b/doc/changelogs/CHANGELOG_V7.md index 9f5581129c1..d32d2451ff4 100644 --- a/doc/changelogs/CHANGELOG_V7.md +++ b/doc/changelogs/CHANGELOG_V7.md @@ -1,8 +1,6 @@ # Node.js 7 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V8.md b/doc/changelogs/CHANGELOG_V8.md index f64372f41b4..ab474c99825 100644 --- a/doc/changelogs/CHANGELOG_V8.md +++ b/doc/changelogs/CHANGELOG_V8.md @@ -1,8 +1,6 @@ # Node.js 8 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> diff --git a/doc/changelogs/CHANGELOG_V9.md b/doc/changelogs/CHANGELOG_V9.md index 6721296dd42..c08ea38714e 100644 --- a/doc/changelogs/CHANGELOG_V9.md +++ b/doc/changelogs/CHANGELOG_V9.md @@ -1,8 +1,6 @@ # Node.js 9 ChangeLog -<!--lint disable prohibited-strings--> -<!--lint disable maximum-line-length--> -<!--lint disable no-literal-urls--> +<!--lint disable maximum-line-length no-literal-urls prohibited-strings--> <table> <tr> |