Skip to content

doc: fix YAML documentation comment starts #38324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aduh95 merged 1 commit into from
Apr 23, 2021
Merged

doc: fix YAML documentation comment starts #38324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: fix YAML comment opening tags 
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 @aduh95
jaydenseric authored and aduh95 committed Apr 23, 2021
commit 37b811a27a7479c99448aafa834efab02b6baf17
2 changes: 1 addition & 1 deletion doc/api/globals.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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