Skip to content

Commit 71f9023

Browse files
nschonniBethGriggs
authored andcommitted
doc: add angle brackets around implicit links
PR-URL: #32676 Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent b4ef062 commit 71f9023

15 files changed

+23
-23
lines changed

BUILDING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ For use of AVX2,
204204
* nasm version 2.10 or higher in Windows
205205

206206
Please refer to
207-
https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html for details.
207+
<https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html> for details.
208208

209209
If compiling without one of the above, use `configure` with the
210210
`--openssl-no-asm` flag. Otherwise, `configure` will fail.
@@ -277,7 +277,7 @@ $ make -j4
277277
If you run into a `No module named 'distutils.spawn'` error when executing
278278
`./configure`, please try `python3 -m pip install --upgrade setuptools` or
279279
`sudo apt install python3-distutils -y`.
280-
For more information, see https://github.com/nodejs/node/issues/30189.
280+
For more information, see <https://github.com/nodejs/node/issues/30189>.
281281

282282
The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which
283283
may reduce build time. For more information, see the

doc/api/deprecations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2352,7 +2352,7 @@ The undocumented `net._setSimultaneousAccepts()` function was originally
23522352
intended for debugging and performance tuning when using the `child_process`
23532353
and `cluster` modules on Windows. The function is not generally useful and
23542354
is being removed. See discussion here:
2355-
https://github.com/nodejs/node/issues/18391
2355+
<https://github.com/nodejs/node/issues/18391>
23562356
23572357
<a id="DEP0122"></a>
23582358
### DEP0122: `tls` `Server.prototype.setOptions()`

doc/api/errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1194,7 +1194,7 @@ is set for the `Http2Stream`.
11941194
### `ERR_INTERNAL_ASSERTION`
11951195

11961196
There was a bug in Node.js or incorrect usage of Node.js internals.
1197-
To fix the error, open an issue at https://github.com/nodejs/node/issues.
1197+
To fix the error, open an issue at <https://github.com/nodejs/node/issues>.
11981198

11991199
<a id="ERR_INCOMPATIBLE_OPTION_PAIR"></a>
12001200
### `ERR_INCOMPATIBLE_OPTION_PAIR`

doc/api/os.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Returns the operating system as a string.
290290

291291
On POSIX systems, the operating system release is determined by calling
292292
[uname(3)][]. On Windows, `GetVersionExW()` is used. See
293-
https://en.wikipedia.org/wiki/Uname#Examples for more information.
293+
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.
294294

295295
## `os.setPriority([pid, ]priority)`
296296
<!-- YAML
@@ -349,7 +349,7 @@ added: v0.3.3
349349
Returns the operating system name as returned by [uname(3)][]. For example, it
350350
returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.
351351

352-
See https://en.wikipedia.org/wiki/Uname#Examples for additional information
352+
See <https://en.wikipedia.org/wiki/Uname#Examples> for additional information
353353
about the output of running [uname(3)][] on various operating systems.
354354

355355
## `os.uptime()`
@@ -401,7 +401,7 @@ Returns a string identifying the kernel version.
401401
On POSIX systems, the operating system release is determined by calling
402402
[uname(3)][]. On Windows, `RtlGetVersion()` is used, and if it is not available,
403403
`GetVersionExW()` will be used. See
404-
https://en.wikipedia.org/wiki/Uname#Examples for more information.
404+
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.
405405

406406
## OS Constants
407407

doc/guides/cve-management-process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The Node.js project acts as a [Common Vulnerabilities and Exposures (CVE)
44
Numbering Authority (CNA)](https://cve.mitre.org/cve/cna.html).
55
The current scope is for all actively developed versions of software
6-
developed under the Node.js project (ie. https://github.com/nodejs).
6+
developed under the Node.js project (ie. <https://github.com/nodejs>).
77
This means that the Node.js team reviews CVE requests and if appropriate
88
assigns CVE numbers to vulnerabilities. The scope currently **does not**
99
include third party modules.
@@ -56,7 +56,7 @@ as outlined in the section titled `CVE Management process`.
5656
In addition, when moving a CVE from Available such that there are less
5757
than two remaining CVEs a new block must be requested as follows:
5858

59-
* Use the Mitre request form https://cveform.mitre.org/ with the
59+
* Use the Mitre request form <https://cveform.mitre.org/> with the
6060
option `Request a Block of IDs` to request a new block.
6161
* The new block will be sent to the requester through email.
6262
* Once the new block has been received, the requester will add them

doc/guides/maintaining-openssl.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This document describes how to update `deps/openssl/`.
55
## Requirements
66
* Linux environment
77
* `perl` Only Perl version 5 is tested.
8-
* `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed.
8+
* `nasm` (<http://www.nasm.us/>) The version of 2.11 or higher is needed.
99
* GNU `as` in binutils. The version of 2.26 or higher is needed.
1010

1111
## 0. Check Requirements
@@ -27,7 +27,7 @@ NASM version 2.11.08
2727

2828
## 1. Obtain and extract new OpenSSL sources
2929

30-
Get a new source from https://www.openssl.org/source/ and extract
30+
Get a new source from <https://www.openssl.org/source/> and extract
3131
all files into `deps/openssl/openssl`. Then add all files and commit
3232
them.
3333
```sh

doc/guides/offboarding.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Emeritus or leaves the project.
1313
* Some teams may also require a pull request to remove the Collaborator from
1414
a team listing. For example, if someone is removed from @nodejs/build,
1515
they should also be removed from the Build WG README.md file in the
16-
https://github.com/nodejs/build repository.
16+
<https://github.com/nodejs/build> repository.

doc/guides/releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -682,7 +682,7 @@ The nodejs.org website will automatically rebuild and include the new version.
682682
To announce the build on Twitter through the official @nodejs account, email
683683
[pr@nodejs.org](mailto:pr@nodejs.org) with a message such as:
684684

685-
> v5.8.0 of @nodejs is out: https://nodejs.org/en/blog/release/v5.8.0/
685+
> v5.8.0 of @nodejs is out: <https://nodejs.org/en/blog/release/v5.8.0/>
686686
>
687687
> something here about notable changes
688688

doc/guides/security-release-process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,6 @@ information described.
8888
* [ ] Make sure the PRs for the vulnerabilities are closed.
8989

9090
[H1 CVE requests]: https://hackerone.com/nodejs/cve_requests
91-
[docker-node]: https://github.com/nodejs/docker-node/issues)
92-
[nodejs/build]: https://github.com/nodejs/build/issues)
91+
[docker-node]: https://github.com/nodejs/docker-node/issues
92+
[nodejs/build]: https://github.com/nodejs/build/issues
9393
[email]: https://groups.google.com/forum/#!forum/nodejs-sec

doc/guides/using-symbols.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Symbol-keyed properties of an object are not included in the output of
99
default.
1010

1111
Learn more about symbols at
12-
https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol.
12+
<https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol>.
1313

1414
## `Symbol(string)`
1515

doc/guides/writing-and-running-benchmarks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ from [nghttp2.org][] or built from source.
5454
### Benchmark Analysis Requirements
5555

5656
To analyze the results, `R` should be installed. Use one of the available
57-
package managers or download it from https://www.r-project.org/.
57+
package managers or download it from <https://www.r-project.org/>.
5858

5959
The R packages `ggplot2` and `plyr` are also used and can be installed using
6060
the R REPL.
@@ -68,7 +68,7 @@ install.packages("plyr")
6868
In the event that a message is reported stating that a CRAN mirror must be
6969
selected first, specify a mirror by adding in the repo parameter.
7070

71-
If we used the "http://cran.us.r-project.org" mirror, it could look something
71+
If we used the "<http://cran.us.r-project.org>" mirror, it could look something
7272
like this:
7373

7474
```R

doc/guides/writing-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ To generate a test coverage report, see the
430430
[Test Coverage section of the Building guide][].
431431

432432
Nightly coverage reports for the Node.js master branch are available at
433-
https://coverage.nodejs.org/.
433+
<https://coverage.nodejs.org/>.
434434

435435
[ASCII]: http://man7.org/linux/man-pages/man7/ascii.7.html
436436
[Google Test]: https://github.com/google/googletest

glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md.
1+
You may also need to check <https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md>.
22

33
* LGTM: "Looks good to me", commonly used to approve a code review.
44
* PTAL: Please take a look.

onboarding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ onboarding session.
165165
* It is not automatically run. You need to start it manually.
166166
* Log in on CI is integrated with GitHub. Try to log in now!
167167
* You will be using `node-test-pull-request` most of the time. Go there now!
168-
* Consider bookmarking it: https://ci.nodejs.org/job/node-test-pull-request/
168+
* Consider bookmarking it: <https://ci.nodejs.org/job/node-test-pull-request/>
169169
* To get to the form to start a job, click on `Build with Parameters`. (If you
170170
don't see it, that probably means you are not logged in!) Click it now!
171171
* To start CI testing from this screen, you need to fill in two elements on
@@ -200,7 +200,7 @@ needs to be pointed out separately during the onboarding.
200200
## Exercise: Make a PR adding yourself to the README
201201

202202
* Example:
203-
https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0
203+
<https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0>
204204
* For raw commit message: `git log ce986de829457c39257cd205067602e765768fb0
205205
-1`
206206
* Collaborators are in alphabetical order by GitHub username.

tools/icu/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Note:
2121
> The files in this directory were written for the Node.js v0.12 effort.
2222
> The original intent was to merge the tools such as `icutrim.py` and `iculslocs.cc`
2323
> back into ICU. ICU has gained its own “data slicer” tool.
24-
> There is an issue open, https://github.com/nodejs/node/issues/25136
24+
> There is an issue open, <https://github.com/nodejs/node/issues/25136>
2525
> for replacing `icutrim.py` with the [ICU data slicer][].
2626
2727
## See Also

0 commit comments

Comments
 (0)