Skip to content

Commit

Permalink
doc: fix YAML comment opening tags
Browse files Browse the repository at this point in the history
Several YAML documentation comments incorrectly started with `<!--YAML`
instead of `<!-- YAML`, resulting in their content missing in the
rendered documentation.

PR-URL: #38324
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
  • Loading branch information
jaydenseric authored and targos committed Sep 4, 2021
1 parent c4686fa commit 95b9cc7
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Affects the default output directory of:
* [--redirect-warnings](#cli_redirect_warnings_file)

### `--disable-proto=mode`
<!--YAML
<!-- YAML
added: v13.12.0
-->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ that are part of the JavaScript language itself, which are also globally
accessible.

## Class: `AbortController`
<!--YAML
<!-- YAML
added: v14.17.0
-->

Expand Down
10 changes: 5 additions & 5 deletions doc/api/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ import submodule from 'es-module-package/private-module.js';
```

### Subpath imports
<!--YAML
<!-- YAML
added:
- v14.6.0
- v12.19.0
Expand Down Expand Up @@ -332,7 +332,7 @@ The resolution rules for the imports field are otherwise
analogous to the exports field.

### Subpath patterns
<!--YAML
<!-- YAML
added:
- v14.13.0
- v12.20.0
Expand Down Expand Up @@ -406,7 +406,7 @@ import featureX from 'es-module-package/features/x';
```

### Exports sugar
<!--YAML
<!-- YAML
added: v12.11.0
-->

Expand All @@ -433,7 +433,7 @@ can be written:
```

### Conditional exports
<!--YAML
<!-- YAML
added:
- v13.2.0
- v12.16.0
Expand Down Expand Up @@ -608,7 +608,7 @@ The above definitions may be moved to a dedicated conditions registry in due
course.

### Self-referencing a package using its name
<!--YAML
<!-- YAML
added:
- v13.1.0
- v12.16.0
Expand Down
2 changes: 1 addition & 1 deletion doc/api/worker_threads.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ new Worker('process.env.SET_IN_WORKER = "foo"', { eval: true, env: SHARE_ENV })
```

## `worker.setEnvironmentData(key[, value])`
<!--YAML
<!-- YAML
added: REPLACEME
-->

Expand Down

0 comments on commit 95b9cc7

Please sign in to comment.