diff options
| author | estrada9166 <estrada9166@hotmail.com> | 2018-02-12 02:31:55 -0500 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2018-02-23 16:26:29 +0000 |
| commit | a29089d7c866955616c0e363843017e9b9b2a736 (patch) | |
| tree | 28bb543eea1a6bd814da31d854daa8680fdc5a90 /doc/guides/writing-tests.md | |
| parent | 3a191229418dcc0e21956847993b1702c88a923b (diff) | |
| download | android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.gz android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.bz2 android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.zip | |
doc: add new documentation lint rule
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.
PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/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>
Diffstat (limited to 'doc/guides/writing-tests.md')
| -rw-r--r-- | doc/guides/writing-tests.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md index aa4412e161..28a062d8b7 100644 --- a/doc/guides/writing-tests.md +++ b/doc/guides/writing-tests.md @@ -138,15 +138,15 @@ platforms. ### The *common* API -Make use of the helpers from the `common` module as much as possible. Please refer -to the [common file documentation](https://github.com/nodejs/node/tree/master/test/common) +Make use of the helpers from the `common` module as much as possible. Please +refer to the [common file documentation](https://github.com/nodejs/node/tree/master/test/common) for the full details of the helpers. #### common.mustCall -One interesting case is `common.mustCall`. The use of `common.mustCall` may avoid -the use of extra variables and the corresponding assertions. Let's explain this -with a real test from the test suite. +One interesting case is `common.mustCall`. The use of `common.mustCall` may +avoid the use of extra variables and the corresponding assertions. Let's +explain this with a real test from the test suite. ```javascript 'use strict'; @@ -200,9 +200,10 @@ const server = http.createServer(common.mustCall(function(req, res) { ``` #### Countdown Module -The common [Countdown module](https://github.com/nodejs/node/tree/master/test/common#countdown-module) provides a simple countdown mechanism for tests that -require a particular action to be taken after a given number of completed tasks -(for instance, shutting down an HTTP server after a specific number of requests). +The common [Countdown module](https://github.com/nodejs/node/tree/master/test/common#countdown-module) +provides a simple countdown mechanism for tests that require a particular +action to be taken after a given number of completed tasks (for instance, +shutting down an HTTP server after a specific number of requests). ```javascript const Countdown = require('../common/countdown'); |