Skip to content

Commit

Permalink
doc: simplify deprecation language
Browse files Browse the repository at this point in the history
Change instances of `foo has been deprecated` to `foo is deprecated` and
similar.

PR-URL: #21136
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
  • Loading branch information
Trott authored and targos committed Jun 13, 2018
1 parent c9cee63 commit 73b8975
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1875,7 +1875,7 @@ console.log(key.toString('hex')); // '3745e48...08d59ae'
```

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

```js
Expand Down
8 changes: 4 additions & 4 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ The [`fs.readSync()`][] legacy `String` interface is deprecated. Use the

Type: Runtime

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

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

The `http` module `outgoingMessage._headers` and `outgoingMessage._headerNames`
properties have been deprecated. Please instead use one of the public methods
properties are deprecated. Use one of the public methods
(e.g. `outgoingMessage.getHeader()`, `outgoingMessage.getHeaders()`,
`outgoingMessage.getHeaderNames()`, `outgoingMessage.hasHeader()`,
`outgoingMessage.removeHeader()`, `outgoingMessage.setHeader()`) for working
Expand Down Expand Up @@ -730,15 +730,15 @@ may be specified.
Type: Documentation-only
The internal `path._makeLong()` was not intended for public use. However,
userland modules have found it useful. The internal API has been deprecated
userland modules have found it useful. The internal API is deprecated
and replaced with an identical, public `path.toNamespacedPath()` method.
<a id="DEP0081"></a>
### DEP0081: fs.truncate() using a file descriptor
Type: Runtime
`fs.truncate()` `fs.truncateSync()` usage with a file descriptor has been
`fs.truncate()` `fs.truncateSync()` usage with a file descriptor is
deprecated. Please use `fs.ftruncate()` or `fs.ftruncateSync()` to work with
file descriptors.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ myEmitter.emit('error', new Error('whoops!'));
```

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

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

Expand Down
2 changes: 1 addition & 1 deletion doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ added: v1.4.1
changes:
- version: v7.0.0
pr-url: https://github.com/nodejs/node/pull/8217
description: Not handling `Promise` rejections has been deprecated.
description: Not handling `Promise` rejections is deprecated.
- version: v6.6.0
pr-url: https://github.com/nodejs/node/pull/8223
description: Unhandled `Promise` rejections will now emit
Expand Down
2 changes: 1 addition & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1269,7 +1269,7 @@ deprecated: v0.11.3
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
The `tls.CryptoStream` class represents a stream of encrypted data. This class
has been deprecated and should no longer be used.
is deprecated and should no longer be used.

#### cryptoStream.bytesWritten
<!-- YAML
Expand Down
2 changes: 1 addition & 1 deletion doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -1595,7 +1595,7 @@ util.types.isWebAssemblyCompiledModule(module); // Returns true

## Deprecated APIs

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

### util.\_extend(target, source)
Expand Down

0 comments on commit 73b8975

Please sign in to comment.