Skip to content

Commit

Permalink
doc: use HEAD for links in api docs
Browse files Browse the repository at this point in the history
Change links in api docs to use HEAD when they
refer to the primary branch.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #37437
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
  • Loading branch information
mhdawson authored and targos committed Feb 28, 2021
1 parent 549d24b commit 54b6f1b
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion doc/api/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -1367,7 +1367,7 @@ console.log(result);
[`Worker`]: worker_threads.md#worker_threads_class_worker
[bindings]: https://github.com/TooTallNate/node-bindings
[download]: https://github.com/nodejs/node-addon-examples
[examples]: https://github.com/nodejs/nan/tree/master/examples/
[examples]: https://github.com/nodejs/nan/tree/HEAD/examples/
[installation instructions]: https://github.com/nodejs/node-gyp#installation
[libuv]: https://github.com/libuv/libuv
[node-gyp]: https://github.com/nodejs/node-gyp
Expand Down
2 changes: 1 addition & 1 deletion doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ be unavoidable.

[Semantic Versioning]: https://semver.org/
[V8 JavaScript engine]: https://v8.dev/
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
[the contributing guide]: https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md
[the issue tracker]: https://github.com/nodejs/node/issues/new
[warning]: process.md#process_event_warning
4 changes: 2 additions & 2 deletions doc/api/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,5 +161,5 @@ int RunNodeInstance(MultiIsolatePlatform* platform,
[CLI options]: cli.md
[`process.memoryUsage()`]: process.md#process_process_memoryusage
[deprecation policy]: deprecations.md
[embedtest.cc]: https://github.com/nodejs/node/blob/master/test/embedding/embedtest.cc
[src/node.h]: https://github.com/nodejs/node/blob/master/src/node.h
[embedtest.cc]: https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc
[src/node.h]: https://github.com/nodejs/node/blob/HEAD/src/node.h
4 changes: 2 additions & 2 deletions doc/api/intl.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,12 @@ to be helpful:
dedicated to ECMA-402.

["ICU Data"]: http://userguide.icu-project.org/icudata
[BUILDING.md]: https://github.com/nodejs/node/blob/master/BUILDING.md
[BUILDING.md]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md
[ECMA-262]: https://tc39.github.io/ecma262/
[ECMA-402]: https://tc39.github.io/ecma402/
[ICU]: http://site.icu-project.org/
[REPL]: repl.md#repl_repl
[Test262]: https://github.com/tc39/test262/tree/master/test/intl402
[Test262]: https://github.com/tc39/test262/tree/HEAD/test/intl402
[WHATWG URL parser]: url.md#url_the_whatwg_url_api
[`--icu-data-dir`]: cli.md#cli_icu_data_dir_file
[`Date.prototype.toLocaleString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString
Expand Down
2 changes: 1 addition & 1 deletion doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6085,7 +6085,7 @@ the add-on's file name during loading.
[`napi_unwrap`]: #n_api_napi_unwrap
[`napi_wrap`]: #n_api_napi_wrap
[`node-addon-api`]: https://github.com/nodejs/node-addon-api
[`node_api.h`]: https://github.com/nodejs/node/blob/master/src/node_api.h
[`node_api.h`]: https://github.com/nodejs/node/blob/HEAD/src/node_api.h
[`process.release`]: process.md#process_process_release
[`uv_ref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_ref
[`uv_unref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_unref
Expand Down
2 changes: 1 addition & 1 deletion doc/api/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,7 @@ The following process scheduling constants are exported by
</tr>
</table>

[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os
[EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID
[`SystemError`]: errors.md#errors_class_systemerror
[`process.arch`]: process.md#process_process_arch
Expand Down
2 changes: 1 addition & 1 deletion doc/api/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@ This field defines [subpath imports][] for the current package.
[CommonJS]: modules.md
[ES module]: esm.md
[ES modules]: esm.md
[Node.js documentation for this section]: https://github.com/nodejs/node/blob/master/doc/api/packages.md#conditions-definitions
[Node.js documentation for this section]: https://github.com/nodejs/node/blob/HEAD/doc/api/packages.md#conditions-definitions
[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported
[`esm`]: https://github.com/standard-things/esm#readme
[`"exports"`]: #packages_exports
Expand Down
4 changes: 2 additions & 2 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1828,7 +1828,7 @@ tarball.
that are no longer supported).
* `'Dubnium'` for the 10.x LTS line beginning with 10.13.0.
* `'Erbium'` for the 12.x LTS line beginning with 12.13.0.
For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_ARCHIVE.md)
For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/HEAD/doc/changelogs/CHANGELOG_ARCHIVE.md)

<!-- eslint-skip -->
```js
Expand Down Expand Up @@ -2671,7 +2671,7 @@ cases:
code will be `128` + `6`, or `134`.

[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os
[Child Process]: child_process.md
[Cluster]: cluster.md
[Duplex]: stream.md#stream_duplex_and_transform_streams
Expand Down

0 comments on commit 54b6f1b

Please sign in to comment.