Skip to content

Commit

Permalink
doc: add blank line between comments
Browse files Browse the repository at this point in the history 
Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.

PR-URL: #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>
  • Loading branch information
@Trott @targos
Trott authored and targos committed Oct 4, 2021
1 parent 847b451 commit 94b415b
Show file tree
Hide file tree
Showing 35 changed files with 40 additions and 51 deletions.
1 change: 1 addition & 0 deletions doc/api/addons.md
View file
@@ -1,6 +1,7 @@
# C++ addons

<!--introduced_in=v0.10.0-->

<!-- type=misc -->

_Addons_ are dynamically-linked shared objects written in C++. The
Expand Down
1 change: 1 addition & 0 deletions doc/api/cli.md
View file
@@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/corepack.md
View file
@@ -1,6 +1,7 @@
# Corepack

<!-- introduced_in=v16.9.0 -->

<!-- type=misc -->

> Stability: 1 - Experimental
Expand Down
1 change: 1 addition & 0 deletions doc/api/deprecations.md
View file
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions doc/api/documentation.md
View file
@@ -1,6 +1,7 @@
# About this documentation

<!--introduced_in=v0.10.0-->

<!-- type=misc -->

Welcome to the official API reference documentation for Node.js!
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/errors.md
View file
@@ -1,6 +1,7 @@
# Errors

<!--introduced_in=v4.0.0-->

<!--type=misc-->

Applications running in Node.js will generally experience four categories of
Expand Down
2 changes: 2 additions & 0 deletions doc/api/esm.md
View file
@@ -1,7 +1,9 @@
# Modules: ECMAScript modules

<!--introduced_in=v8.5.0-->

<!-- type=misc -->

<!-- YAML
added: v8.5.0
changes:
Expand Down
1 change: 1 addition & 0 deletions doc/api/globals.md
View file
@@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/intl.md
View file
@@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/module.md
View file
@@ -1,6 +1,7 @@
# Modules: `module` API

<!--introduced_in=v12.20.0-->

<!-- YAML
added: v0.3.7
-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/modules.md
View file
Expand Up @@ -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
Expand Down Expand Up @@ -773,6 +774,7 @@ added: v0.1.16
-->

<!-- type=var -->

<!-- name=module -->

* {Object}
Expand Down
1 change: 1 addition & 0 deletions doc/api/n-api.md
View file
@@ -1,6 +1,7 @@
# Node-API

<!--introduced_in=v8.0.0-->

<!-- type=misc -->

> Stability: 2 - Stable
Expand Down
1 change: 1 addition & 0 deletions doc/api/net.md
View file
@@ -1,6 +1,7 @@
# Net

<!--introduced_in=v0.10.0-->

<!--lint disable maximum-line-length-->

> Stability: 2 - Stable
Expand Down
2 changes: 2 additions & 0 deletions doc/api/packages.md
View file
@@ -1,7 +1,9 @@
# Modules: Packages

<!--introduced_in=v12.20.0-->

<!-- type=misc -->

<!-- YAML
changes:
- version:
Expand Down
1 change: 1 addition & 0 deletions doc/api/policy.md
View file
@@ -1,6 +1,7 @@
# Policies

<!--introduced_in=v11.8.0-->

<!-- type=misc -->

> Stability: 1 - Experimental
Expand Down
2 changes: 2 additions & 0 deletions doc/api/process.md
View file
@@ -1,6 +1,7 @@
# Process

<!-- introduced_in=v0.10.0 -->

<!-- type=global -->

<!-- source_link=lib/process.js -->
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/api/report.md
View file
@@ -1,6 +1,7 @@
# Diagnostic report

<!--introduced_in=v11.8.0-->

<!-- type=misc -->

> Stability: 2 - Stable
Expand Down
1 change: 1 addition & 0 deletions doc/api/synopsis.md
View file
Expand Up @@ -3,6 +3,7 @@
## Usage

<!--introduced_in=v0.10.0-->

<!--type=misc-->

`node [options] [V8 options] [script.js | -e "script" | - ] [arguments]`
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_ARCHIVE.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_IOJS.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V010.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V012.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V10.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V11.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V12.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V13.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V14.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V15.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V16.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V4.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V5.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V6.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V7.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V8.md
View file
@@ -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>
Expand Down
4 changes: 1 addition & 3 deletions doc/changelogs/CHANGELOG_V9.md
View file
@@ -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>
Expand Down

0 comments on commit 94b415b

Please sign in to comment.