Skip to content

Commit 73b8975

Browse files
Trotttargos
authored andcommitted
doc: simplify deprecation language
Change instances of `foo has been deprecated` to `foo is deprecated` and similar. PR-URL: #21136 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent c9cee63 commit 73b8975

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

doc/api/crypto.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1875,7 +1875,7 @@ console.log(key.toString('hex')); // '3745e48...08d59ae'
18751875
```
18761876

18771877
The `crypto.DEFAULT_ENCODING` property may be used to change the way the
1878-
`derivedKey` is returned. This property, however, has been deprecated and use
1878+
`derivedKey` is returned. This property, however, is deprecated and use
18791879
should be avoided.
18801880

18811881
```js

doc/api/deprecations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ The [`fs.readSync()`][] legacy `String` interface is deprecated. Use the
192192

193193
Type: Runtime
194194

195-
The `GLOBAL` and `root` aliases for the `global` property have been deprecated
195+
The `GLOBAL` and `root` aliases for the `global` property are deprecated
196196
and should no longer be used.
197197

198198
<a id="DEP0017"></a>
@@ -581,7 +581,7 @@ removed. Please use `sloppy` instead.
581581
Type: Documentation-only
582582

583583
The `http` module `outgoingMessage._headers` and `outgoingMessage._headerNames`
584-
properties have been deprecated. Please instead use one of the public methods
584+
properties are deprecated. Use one of the public methods
585585
(e.g. `outgoingMessage.getHeader()`, `outgoingMessage.getHeaders()`,
586586
`outgoingMessage.getHeaderNames()`, `outgoingMessage.hasHeader()`,
587587
`outgoingMessage.removeHeader()`, `outgoingMessage.setHeader()`) for working
@@ -730,15 +730,15 @@ may be specified.
730730
Type: Documentation-only
731731
732732
The internal `path._makeLong()` was not intended for public use. However,
733-
userland modules have found it useful. The internal API has been deprecated
733+
userland modules have found it useful. The internal API is deprecated
734734
and replaced with an identical, public `path.toNamespacedPath()` method.
735735
736736
<a id="DEP0081"></a>
737737
### DEP0081: fs.truncate() using a file descriptor
738738
739739
Type: Runtime
740740
741-
`fs.truncate()` `fs.truncateSync()` usage with a file descriptor has been
741+
`fs.truncate()` `fs.truncateSync()` usage with a file descriptor is
742742
deprecated. Please use `fs.ftruncate()` or `fs.ftruncateSync()` to work with
743743
file descriptors.
744744

doc/api/events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ myEmitter.emit('error', new Error('whoops!'));
142142
```
143143

144144
To guard against crashing the Node.js process the [`domain`][] module can be
145-
used. (Note, however, that the `domain` module has been deprecated.)
145+
used. (Note, however, that the `domain` module is deprecated.)
146146

147147
As a best practice, listeners should always be added for the `'error'` events.
148148

doc/api/process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ added: v1.4.1
205205
changes:
206206
- version: v7.0.0
207207
pr-url: https://github.com/nodejs/node/pull/8217
208-
description: Not handling `Promise` rejections has been deprecated.
208+
description: Not handling `Promise` rejections is deprecated.
209209
- version: v6.6.0
210210
pr-url: https://github.com/nodejs/node/pull/8223
211211
description: Unhandled `Promise` rejections will now emit

doc/api/tls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1269,7 +1269,7 @@ deprecated: v0.11.3
12691269
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
12701270
12711271
The `tls.CryptoStream` class represents a stream of encrypted data. This class
1272-
has been deprecated and should no longer be used.
1272+
is deprecated and should no longer be used.
12731273

12741274
#### cryptoStream.bytesWritten
12751275
<!-- YAML

doc/api/util.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1595,7 +1595,7 @@ util.types.isWebAssemblyCompiledModule(module); // Returns true
15951595

15961596
## Deprecated APIs
15971597

1598-
The following APIs have been deprecated and should no longer be used. Existing
1598+
The following APIs are deprecated and should no longer be used. Existing
15991599
applications and modules should be updated to find alternative approaches.
16001600

16011601
### util.\_extend(target, source)

0 commit comments

Comments
 (0)