diff options
author | Derek Lewis <DerekNonGeneric@inf.is> | 2020-05-23 19:34:40 -0400 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2020-05-30 04:22:04 +0200 |
commit | 4a8f6b6331ea8e9291ee3c6a03b6f2fbfa8d1343 (patch) | |
tree | e9f0f218c225ddab9efb05a4a57a4482db9f1a8a /doc | |
parent | f7626866d5957fa39b8070b3dca2634773998137 (diff) | |
download | node-new-4a8f6b6331ea8e9291ee3c6a03b6f2fbfa8d1343.tar.gz |
doc: normalize JavaScript code block info strings
Prior to this commit, JavaScript fenced code blocks in Markdown files
had inconsistent info strings. This has been corrected to standardize
on the one with the highest frequency in the doc/api/ dir.
Stats:
> 'js' => 1091,
> 'javascript' => 2,
PR-URL: https://github.com/nodejs/node/pull/33531
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/fs.md | 2 | ||||
-rw-r--r-- | doc/api/stream.md | 2 | ||||
-rw-r--r-- | doc/guides/writing-tests.md | 22 |
3 files changed, 13 insertions, 13 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index d4b8b7477c..21bb160313 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -4280,7 +4280,7 @@ recommended. When `file` is a file descriptor, the behavior is almost identical to directly calling `fs.write()` like: -```javascript +```js fs.write(fd, Buffer.from(data, options.encoding), callback); ``` diff --git a/doc/api/stream.md b/doc/api/stream.md index 1c9a40bc9f..06700b0597 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -895,7 +895,7 @@ The `'readable'` event is emitted when there is data available to be read from the stream. In some cases, attaching a listener for the `'readable'` event will cause some amount of data to be read into an internal buffer. -```javascript +```js const readable = getReadableStreamSomehow(); readable.on('readable', function() { // There is some data to read now. diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md index 61f202ed9a..e441d93411 100644 --- a/doc/guides/writing-tests.md +++ b/doc/guides/writing-tests.md @@ -29,7 +29,7 @@ For example, look for `test-streams` when writing a test for `lib/streams.js`. Let's analyze this basic test from the Node.js test suite: -```javascript +```js 'use strict'; // 1 const common = require('../common'); // 2 const fixtures = require('../common/fixtures'); // 3 @@ -57,7 +57,7 @@ server.listen(0, () => { // 14 ### **Lines 1-3** -```javascript +```js 'use strict'; const common = require('../common'); const fixtures = require('../common/fixtures'); @@ -78,13 +78,13 @@ the test leaks variables into the global space. In situations where a test uses no functions or other properties exported by `common`, include it without assigning it to an identifier: -```javascript +```js require('../common'); ``` ### **Lines 5-6** -```javascript +```js // This test ensures that the http-parser can handle UTF-8 characters // in the http header. ``` @@ -94,7 +94,7 @@ designed to test. ### **Lines 8-9** -```javascript +```js const assert = require('assert'); const http = require('http'); ``` @@ -136,7 +136,7 @@ In the event a test needs a timer, consider using the `common.platformTimeout()` method. It allows setting specific timeouts depending on the platform: -```javascript +```js const timer = setTimeout(fail, common.platformTimeout(4000)); ``` @@ -155,7 +155,7 @@ 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 +```js 'use strict'; require('../common'); const assert = require('assert'); @@ -189,7 +189,7 @@ const server = http.createServer((req, res) => { This test could be greatly simplified by using `common.mustCall` like this: -```javascript +```js 'use strict'; const common = require('../common'); const http = require('http'); @@ -216,7 +216,7 @@ 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 +```js const Countdown = require('../common/countdown'); const countdown = new Countdown(2, () => { @@ -237,7 +237,7 @@ hence, the test fail - in the case of an `unhandledRejection` event. It is possible to disable it with `common.disableCrashOnUnhandledRejection()` if needed. -```javascript +```js const common = require('../common'); const assert = require('assert'); const fs = require('fs').promises; @@ -257,7 +257,7 @@ test followed by the flags. For example, to allow a test to require some of the `internal/*` modules, add the `--expose-internals` flag. A test that would require `internal/freelist` could start like this: -```javascript +```js 'use strict'; // Flags: --expose-internals |