Skip to content

Commit a29089d

Browse files
estrada9166BridgeAR
authored andcommitted
doc: add new documentation lint rule
Add 80 characters limit to docs. Change docs to fit 80 characters per row. PR-URL: #18726 Fixes: #18703 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
1 parent 3a19122 commit a29089d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+351
-252
lines changed

BUILDING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ Support is divided into three tiers:
3434
### Supported platforms
3535

3636
The community does not build or test against end-of-life distributions (EoL).
37-
Thus we do not recommend that you use Node on end-of-life or unsupported platforms
38-
in production.
37+
Thus we do not recommend that you use Node on end-of-life or unsupported
38+
platforms in production.
3939

4040
| System | Support type | Version | Architectures | Notes |
4141
|--------------|--------------|----------------------------------|----------------------|------------------|
@@ -107,9 +107,11 @@ installed, you can find them under the menu `Xcode -> Open Developer Tool ->
107107
More Developer Tools...`. This step will install `clang`, `clang++`, and
108108
`make`.
109109
* After building, you may want to setup [firewall rules](tools/macosx-firewall.sh)
110-
to avoid popups asking to accept incoming network connections when running tests:
110+
to avoid popups asking to accept incoming network connections when running
111+
tests:
111112

112-
If the path to your build directory contains a space, the build will likely fail.
113+
If the path to your build directory contains a space, the build will likely
114+
fail.
113115

114116
```console
115117
$ sudo ./tools/macosx-firewall.sh
@@ -232,8 +234,8 @@ Prerequisites:
232234
* **Optional** (to build the MSI): the [WiX Toolset v3.11](http://wixtoolset.org/releases/)
233235
and the [Wix Toolset Visual Studio 2017 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WixToolsetVisualStudio2017Extension).
234236

235-
If the path to your build directory contains a space or a non-ASCII character, the
236-
build will likely fail.
237+
If the path to your build directory contains a space or a non-ASCII character,
238+
the build will likely fail.
237239

238240
```console
239241
> .\vcbuild

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Node.js Changelog
22

3+
<!--lint disable maximum-line-length-->
4+
35
To make the changelog easier to both use and manage, it has been split into
46
multiple files organized according to significant major and minor Node.js
57
release lines.

COLLABORATOR_GUIDE.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -154,22 +154,23 @@ The pull request should have a CI status indicator if possible.
154154
#### Useful CI Jobs
155155

156156
* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
157-
is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`,
158-
which runs the `build-ci` and `test-ci` targets on all supported platforms.
157+
is the standard CI run we do to check Pull Requests. It triggers
158+
`node-test-commit`, which runs the `build-ci` and `test-ci` targets on all
159+
supported platforms.
159160

160161
* [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/)
161-
only runs the linter targets, which is useful for changes that only affect comments
162-
or documentation.
162+
only runs the linter targets, which is useful for changes that only affect
163+
comments or documentation.
163164

164165
* [`node-test-pull-request-lite`](https://ci.nodejs.org/job/node-test-pull-request-lite/)
165-
only runs the linter job, as well as the tests on LinuxONE. Should only be used for
166-
trivial changes that do not require being tested on all platforms.
166+
only runs the linter job, as well as the tests on LinuxONE. Should only be used
167+
for trivial changes that do not require being tested on all platforms.
167168

168169
* [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/)
169-
uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test`
170-
on a large selection of common modules. This is useful to check whether a
171-
change will cause breakage in the ecosystem. To test Node.js ABI changes
172-
you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
170+
uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run
171+
`npm install && npm test` on a large selection of common modules. This is
172+
useful to check whether a change will cause breakage in the ecosystem. To test
173+
Node.js ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
173174

174175
* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
175176
is designed to allow one to run a group of tests over and over on a specific
@@ -483,17 +484,18 @@ Apply external patches:
483484
$ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am --whitespace=fix
484485
```
485486

486-
If the merge fails even though recent CI runs were successful, then a 3-way merge may
487-
be required. In this case try:
487+
If the merge fails even though recent CI runs were successful, then a 3-way
488+
merge may be required. In this case try:
488489

489490
```text
490491
$ git am --abort
491492
$ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace=fix
492493
```
493494
If the 3-way merge succeeds you can proceed, but make sure to check the changes
494495
against the original PR carefully and build/test on at least one platform
495-
before landing. If the 3-way merge fails, then it is most likely that a conflicting
496-
PR has landed since the CI run and you will have to ask the author to rebase.
496+
before landing. If the 3-way merge fails, then it is most likely that a
497+
conflicting PR has landed since the CI run and you will have to ask the author
498+
to rebase.
497499

498500
Check and re-review the changes:
499501

GOVERNANCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ repository, with a summary of the nominee's contributions, for example:
159159
* Participation in other projects, teams, and working groups of the
160160
Node.js organization
161161
* Can be shown using the links
162-
`https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
162+
`https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
163163
and
164-
`https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
164+
`https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
165165
* Other participation in the wider Node.js community
166166

167167
Mention @nodejs/collaborators in the issue to notify other Collaborators about

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<p align="center">
22
<a href="https://nodejs.org/">
3-
<img alt="Node.js" src="https://nodejs.org/static/images/logo-light.svg" width="400"/>
3+
<img
4+
alt="Node.js"
5+
src="https://nodejs.org/static/images/logo-light.svg"
6+
width="400"
7+
/>
48
</a>
59
</p>
610

doc/api/_toc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
@// NB(chrisdickinson): if you move this file, be sure to update tools/doc/html.js to
2-
@// point at the new location.
1+
@// NB(chrisdickinson): if you move this file, be sure to update
2+
@// tools/doc/html.js to point at the new location.
33
* [About these Docs](documentation.html)
44
* [Usage & Example](synopsis.html)
55

doc/api/assert.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ changes:
2525
description: Added strict mode to the assert module.
2626
-->
2727

28-
When using the `strict mode`, any `assert` function will use the equality used in
29-
the strict function mode. So [`assert.deepEqual()`][] will, for example, work the
30-
same as [`assert.deepStrictEqual()`][].
28+
When using the `strict mode`, any `assert` function will use the equality used
29+
in the strict function mode. So [`assert.deepEqual()`][] will, for example,
30+
work the same as [`assert.deepStrictEqual()`][].
3131

3232
On top of that, error messages which involve objects produce an error diff
3333
instead of displaying both objects. That is not the case for the legacy mode.
@@ -209,8 +209,8 @@ changes:
209209
- version: v9.0.0
210210
pr-url: https://github.com/nodejs/node/pull/15036
211211
description: NaN is now compared using the
212-
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero)
213-
comparison.
212+
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero)
213+
comparison.
214214
- version: v8.5.0
215215
pr-url: https://github.com/nodejs/node/pull/15001
216216
description: Error names and messages are now properly compared
@@ -621,8 +621,8 @@ changes:
621621
- version: v9.0.0
622622
pr-url: https://github.com/nodejs/node/pull/15036
623623
description: NaN is now compared using the
624-
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero)
625-
comparison.
624+
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero)
625+
comparison.
626626
- version: v9.0.0
627627
pr-url: https://github.com/nodejs/node/pull/15001
628628
description: Error names and messages are now properly compared

doc/api/async_hooks.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ instance is destroyed.
206206
* `type` {string} The type of the async resource.
207207
* `triggerAsyncId` {number} The unique ID of the async resource in whose
208208
execution context this async resource was created.
209-
* `resource` {Object} Reference to the resource representing the async operation,
210-
needs to be released during _destroy_.
209+
* `resource` {Object} Reference to the resource representing the async
210+
operation, needs to be released during _destroy_.
211211

212212
Called when a class is constructed that has the _possibility_ to emit an
213213
asynchronous event. This _does not_ mean the instance must call
@@ -283,11 +283,11 @@ The `TCPSERVERWRAP` is the server which receives the connections.
283283

284284
The `TCPWRAP` is the new connection from the client. When a new
285285
connection is made the `TCPWrap` instance is immediately constructed. This
286-
happens outside of any JavaScript stack (side note: a `executionAsyncId()` of `0`
287-
means it's being executed from C++, with no JavaScript stack above it).
286+
happens outside of any JavaScript stack (side note: a `executionAsyncId()` of
287+
`0` means it's being executed from C++, with no JavaScript stack above it).
288288
With only that information, it would be impossible to link resources together in
289-
terms of what caused them to be created, so `triggerAsyncId` is given the task of
290-
propagating what resource is responsible for the new resource's existence.
289+
terms of what caused them to be created, so `triggerAsyncId` is given the task
290+
of propagating what resource is responsible for the new resource's existence.
291291

292292
###### `resource`
293293

@@ -582,8 +582,8 @@ the details of the V8 [PromiseHooks][] API.
582582
## JavaScript Embedder API
583583

584584
Library developers that handle their own asynchronous resources performing tasks
585-
like I/O, connection pooling, or managing callback queues may use the `AsyncWrap`
586-
JavaScript API so that all the appropriate callbacks are called.
585+
like I/O, connection pooling, or managing callback queues may use the
586+
`AsyncWrap` JavaScript API so that all the appropriate callbacks are called.
587587

588588
### `class AsyncResource()`
589589

@@ -734,8 +734,8 @@ never be called.
734734

735735
#### `asyncResource.triggerAsyncId()`
736736

737-
* Returns: {number} The same `triggerAsyncId` that is passed to the `AsyncResource`
738-
constructor.
737+
* Returns: {number} The same `triggerAsyncId` that is passed to the
738+
`AsyncResource` constructor.
739739

740740
[`after` callback]: #async_hooks_after_asyncid
741741
[`asyncResource.runInAsyncScope()`]: #async_hooks_asyncresource_runinasyncscope_fn_thisarg_args

doc/api/buffer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Buffer
22

33
<!--introduced_in=v0.10.0-->
4+
<!--lint disable maximum-line-length-->
45

56
> Stability: 2 - Stable
67

doc/api/child_process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Child Process
22

33
<!--introduced_in=v0.10.0-->
4+
<!--lint disable maximum-line-length-->
45

56
> Stability: 2 - Stable
67

0 commit comments

Comments
 (0)