Skip to content

Commit

Permalink
doc: update vm.md for link linting
Browse files Browse the repository at this point in the history
Update vm.md for link linting rules that are about to be applied. Define
an undefined link reference. Escape non-link text that uses `[` and `]`.

PR-URL: nodejs#29982
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
Trott authored and aduh95 committed Jan 8, 2020
1 parent e345af4 commit ba2725c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/vm.md
Expand Up @@ -562,7 +562,7 @@ flag enabled.*
The `vm.SourceTextModule` class provides the [Source Text Module Record][] as
defined in the ECMAScript specification.

### Constructor: `new vm.SourceTextModule(code[, options])`
### Constructor: `new vm.SourceTextModule(code\[, options\])`

* `code` {string} JavaScript Module code to parse
* `options`
Expand Down Expand Up @@ -653,7 +653,7 @@ const module = new vm.SyntheticModule(['default'], function() {
// Use `module` in linking...
```

### Constructor: `new vm.SyntheticModule(exportNames, evaluateCallback[, options])`
### Constructor: `new vm.SyntheticModule(exportNames, evaluateCallback\[, options\])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -1168,6 +1168,7 @@ queues.
[GetModuleNamespace]: https://tc39.es/ecma262/#sec-getmodulenamespace
[HostResolveImportedModule]: https://tc39.es/ecma262/#sec-hostresolveimportedmodule
[Link() concrete method]: https://tc39.es/ecma262/#sec-moduledeclarationlinking
[Module Record]: https://www.ecma-international.org/ecma-262/#sec-abstract-module-records
[Source Text Module Record]: https://tc39.es/ecma262/#sec-source-text-module-records
[Synthetic Module Record]: https://heycam.github.io/webidl/#synthetic-module-records
[V8 Embedder's Guide]: https://v8.dev/docs/embed#contexts
Expand Down

0 comments on commit ba2725c

Please sign in to comment.