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 Apr 29, 2021
1 parent 25052dc commit 1cccc2d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
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: v15.0.0
changes:
- version: v15.4.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 @@ -291,7 +291,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 @@ -333,7 +333,7 @@ The resolution rules for the imports field are otherwise
analogous to the exports field.

### Subpath patterns
<!--YAML
<!-- YAML
added:
- v14.13.0
- v12.19.0
Expand Down Expand Up @@ -428,7 +428,7 @@ The benefit of patterns over folder exports is that packages can always be
imported by consumers without subpath file extensions being necessary.

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

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

### Conditional exports
<!--YAML
<!-- YAML
added:
- v13.2.0
- v12.16.0
Expand Down Expand Up @@ -630,7 +630,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 @@ -279,7 +279,7 @@ new Worker('process.env.SET_IN_WORKER = "foo"', { eval: true, env: SHARE_ENV })
```

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

Expand Down

0 comments on commit 1cccc2d

Please sign in to comment.