Skip to content

Commit 42dbb60

Browse files
committed
doc: use "is" rather than "has been"
In deprecations.md, there are many uses of "has been" that are mildly awkward. This changes several instances of things like "fhqwhgads() has been deprecated" to "fhqwhgads() is deprecated". Especially for non-native speakers, present tense is generally easier to read and understand than past participles. (Or at least that's my experience reading things in languages other than English.) PR-URL: #21043 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent dce6d53 commit 42dbb60

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

doc/api/deprecations.md

+38-38
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<!-- type=misc -->
55

66
Node.js may deprecate APIs when either: (a) use of the API is considered to be
7-
unsafe, (b) an improved alternative API has been made available, or (c)
8-
breaking changes to the API are expected in a future major release.
7+
unsafe, (b) an improved alternative API is available, or (c) breaking changes to
8+
the API are expected in a future major release.
99

1010
Node.js utilizes three kinds of Deprecations:
1111

@@ -27,8 +27,8 @@ be printed to `stderr` the first time the deprecated API is used. When the
2727
`--throw-deprecation` command-line flag is used, a Runtime deprecation will
2828
cause an error to be thrown.
2929

30-
An End-of-Life deprecation is used to identify code that either has been
31-
removed or will soon be removed from Node.js.
30+
An End-of-Life deprecation is used when functionality is or will soon be removed
31+
from Node.js.
3232

3333
## Revoking deprecations
3434

@@ -123,7 +123,7 @@ precisely describe the actual semantics and was unnecessarily emotion-laden.
123123

124124
Type: Documentation-only
125125

126-
The `constants` module has been deprecated. When requiring access to constants
126+
The `constants` module is deprecated. When requiring access to constants
127127
relevant to specific Node.js builtin modules, developers should instead refer
128128
to the `constants` property exposed by the relevant module. For instance,
129129
`require('fs').constants` and `require('os').constants`.
@@ -303,7 +303,7 @@ instead.
303303

304304
Type: Documentation-only
305305

306-
The [`SlowBuffer`][] class has been deprecated. Please use
306+
The [`SlowBuffer`][] class is deprecated. Please use
307307
[`Buffer.allocUnsafeSlow(size)`][] instead.
308308

309309
<a id="DEP0031"></a>
@@ -326,58 +326,58 @@ The [`domain`][] module is deprecated and should not be used.
326326

327327
Type: Documentation-only
328328

329-
The [`EventEmitter.listenerCount(emitter, eventName)`][] API has been
329+
The [`EventEmitter.listenerCount(emitter, eventName)`][] API is
330330
deprecated. Please use [`emitter.listenerCount(eventName)`][] instead.
331331

332332
<a id="DEP0034"></a>
333333
### DEP0034: fs.exists(path, callback)
334334

335335
Type: Documentation-only
336336

337-
The [`fs.exists(path, callback)`][] API has been deprecated. Please use
337+
The [`fs.exists(path, callback)`][] API is deprecated. Please use
338338
[`fs.stat()`][] or [`fs.access()`][] instead.
339339

340340
<a id="DEP0035"></a>
341341
### DEP0035: fs.lchmod(path, mode, callback)
342342

343343
Type: Documentation-only
344344

345-
The [`fs.lchmod(path, mode, callback)`][] API has been deprecated.
345+
The [`fs.lchmod(path, mode, callback)`][] API is deprecated.
346346

347347
<a id="DEP0036"></a>
348348
### DEP0036: fs.lchmodSync(path, mode)
349349

350350
Type: Documentation-only
351351

352-
The [`fs.lchmodSync(path, mode)`][] API has been deprecated.
352+
The [`fs.lchmodSync(path, mode)`][] API is deprecated.
353353

354354
<a id="DEP0037"></a>
355355
### DEP0037: fs.lchown(path, uid, gid, callback)
356356

357357
Type: Documentation-only
358358

359-
The [`fs.lchown(path, uid, gid, callback)`][] API has been deprecated.
359+
The [`fs.lchown(path, uid, gid, callback)`][] API is deprecated.
360360

361361
<a id="DEP0038"></a>
362362
### DEP0038: fs.lchownSync(path, uid, gid)
363363

364364
Type: Documentation-only
365365

366-
The [`fs.lchownSync(path, uid, gid)`][] API has been deprecated.
366+
The [`fs.lchownSync(path, uid, gid)`][] API is deprecated.
367367

368368
<a id="DEP0039"></a>
369369
### DEP0039: require.extensions
370370

371371
Type: Documentation-only
372372

373-
The [`require.extensions`][] property has been deprecated.
373+
The [`require.extensions`][] property is deprecated.
374374

375375
<a id="DEP0040"></a>
376376
### DEP0040: punycode module
377377

378378
Type: Documentation-only
379379

380-
The [`punycode`][] module has been deprecated. Please use a userland alternative
380+
The [`punycode`][] module is deprecated. Please use a userland alternative
381381
instead.
382382

383383
<a id="DEP0041"></a>
@@ -393,137 +393,137 @@ The `NODE_REPL_HISTORY_FILE` environment variable was removed. Please use
393393

394394
Type: Documentation-only
395395

396-
The [`tls.CryptoStream`][] class has been deprecated. Please use
396+
The [`tls.CryptoStream`][] class is deprecated. Please use
397397
[`tls.TLSSocket`][] instead.
398398

399399
<a id="DEP0043"></a>
400400
### DEP0043: tls.SecurePair
401401

402402
Type: Documentation-only
403403

404-
The [`tls.SecurePair`][] class has been deprecated. Please use
404+
The [`tls.SecurePair`][] class is deprecated. Please use
405405
[`tls.TLSSocket`][] instead.
406406

407407
<a id="DEP0044"></a>
408408
### DEP0044: util.isArray()
409409

410410
Type: Documentation-only
411411

412-
The [`util.isArray()`][] API has been deprecated. Please use `Array.isArray()`
412+
The [`util.isArray()`][] API is deprecated. Please use `Array.isArray()`
413413
instead.
414414

415415
<a id="DEP0045"></a>
416416
### DEP0045: util.isBoolean()
417417

418418
Type: Documentation-only
419419

420-
The [`util.isBoolean()`][] API has been deprecated.
420+
The [`util.isBoolean()`][] API is deprecated.
421421

422422
<a id="DEP0046"></a>
423423
### DEP0046: util.isBuffer()
424424

425425
Type: Documentation-only
426426

427-
The [`util.isBuffer()`][] API has been deprecated. Please use
427+
The [`util.isBuffer()`][] API is deprecated. Please use
428428
[`Buffer.isBuffer()`][] instead.
429429

430430
<a id="DEP0047"></a>
431431
### DEP0047: util.isDate()
432432

433433
Type: Documentation-only
434434

435-
The [`util.isDate()`][] API has been deprecated.
435+
The [`util.isDate()`][] API is deprecated.
436436

437437
<a id="DEP0048"></a>
438438
### DEP0048: util.isError()
439439

440440
Type: Documentation-only
441441

442-
The [`util.isError()`][] API has been deprecated.
442+
The [`util.isError()`][] API is deprecated.
443443

444444
<a id="DEP0049"></a>
445445
### DEP0049: util.isFunction()
446446

447447
Type: Documentation-only
448448

449-
The [`util.isFunction()`][] API has been deprecated.
449+
The [`util.isFunction()`][] API is deprecated.
450450

451451
<a id="DEP0050"></a>
452452
### DEP0050: util.isNull()
453453

454454
Type: Documentation-only
455455

456-
The [`util.isNull()`][] API has been deprecated.
456+
The [`util.isNull()`][] API is deprecated.
457457

458458
<a id="DEP0051"></a>
459459
### DEP0051: util.isNullOrUndefined()
460460

461461
Type: Documentation-only
462462

463-
The [`util.isNullOrUndefined()`][] API has been deprecated.
463+
The [`util.isNullOrUndefined()`][] API is deprecated.
464464

465465
<a id="DEP0052"></a>
466466
### DEP0052: util.isNumber()
467467

468468
Type: Documentation-only
469469

470-
The [`util.isNumber()`][] API has been deprecated.
470+
The [`util.isNumber()`][] API is deprecated.
471471

472472
<a id="DEP0053"></a>
473473
### DEP0053 util.isObject()
474474

475475
Type: Documentation-only
476476

477-
The [`util.isObject()`][] API has been deprecated.
477+
The [`util.isObject()`][] API is deprecated.
478478

479479
<a id="DEP0054"></a>
480480
### DEP0054: util.isPrimitive()
481481

482482
Type: Documentation-only
483483

484-
The [`util.isPrimitive()`][] API has been deprecated.
484+
The [`util.isPrimitive()`][] API is deprecated.
485485

486486
<a id="DEP0055"></a>
487487
### DEP0055: util.isRegExp()
488488

489489
Type: Documentation-only
490490

491-
The [`util.isRegExp()`][] API has been deprecated.
491+
The [`util.isRegExp()`][] API is deprecated.
492492

493493
<a id="DEP0056"></a>
494494
### DEP0056: util.isString()
495495

496496
Type: Documentation-only
497497

498-
The [`util.isString()`][] API has been deprecated.
498+
The [`util.isString()`][] API is deprecated.
499499

500500
<a id="DEP0057"></a>
501501
### DEP0057: util.isSymbol()
502502

503503
Type: Documentation-only
504504

505-
The [`util.isSymbol()`][] API has been deprecated.
505+
The [`util.isSymbol()`][] API is deprecated.
506506

507507
<a id="DEP0058"></a>
508508
### DEP0058: util.isUndefined()
509509

510510
Type: Documentation-only
511511

512-
The [`util.isUndefined()`][] API has been deprecated.
512+
The [`util.isUndefined()`][] API is deprecated.
513513

514514
<a id="DEP0059"></a>
515515
### DEP0059: util.log()
516516

517517
Type: Documentation-only
518518

519-
The [`util.log()`][] API has been deprecated.
519+
The [`util.log()`][] API is deprecated.
520520

521521
<a id="DEP0060"></a>
522522
### DEP0060: util.\_extend()
523523

524524
Type: Documentation-only
525525

526-
The [`util._extend()`][] API has been deprecated.
526+
The [`util._extend()`][] API is deprecated.
527527

528528
<a id="DEP0061"></a>
529529
### DEP0061: fs.SyncWriteStream
@@ -539,7 +539,7 @@ alternative.
539539

540540
Type: Runtime
541541

542-
`--debug` activates the legacy V8 debugger interface, which has been removed as
542+
`--debug` activates the legacy V8 debugger interface, which was removed as
543543
of V8 5.8. It is replaced by Inspector which is activated with `--inspect`
544544
instead.
545545

@@ -548,7 +548,7 @@ instead.
548548

549549
Type: Documentation-only
550550

551-
The `http` module `ServerResponse.prototype.writeHeader()` API has been
551+
The `http` module `ServerResponse.prototype.writeHeader()` API is
552552
deprecated. Please use `ServerResponse.prototype.writeHead()` instead.
553553

554554
The `ServerResponse.prototype.writeHeader()` method was never documented as an
@@ -596,7 +596,7 @@ were never documented as officially supported properties.
596596

597597
Type: Documentation-only
598598

599-
The `http` module `OutgoingMessage.prototype._renderHeaders()` API has been
599+
The `http` module `OutgoingMessage.prototype._renderHeaders()` API is
600600
deprecated.
601601

602602
The `OutgoingMessage.prototype._renderHeaders` property was never documented as
@@ -655,7 +655,7 @@ This change was made while `async_hooks` was an experimental API.
655655
Type: End-of-Life
656656

657657
Accessing several internal, undocumented properties of `net.Server` instances
658-
with inappropriate names has been deprecated.
658+
with inappropriate names is deprecated.
659659

660660
As the original API was undocumented and not generally useful for non-internal
661661
code, no replacement API is provided.
@@ -703,7 +703,7 @@ difference is that `querystring.parse()` does url decoding:
703703
704704
Type: Runtime
705705
706-
`Module._debug()` has been deprecated.
706+
`Module._debug()` is deprecated.
707707
708708
The `Module._debug()` function was never documented as an officially
709709
supported API.

0 commit comments

Comments
 (0)