From a22e250eb51b53e711fbd3b510e71ee8ba661ecd Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Jun 2018 11:58:47 -0700 Subject: [PATCH] doc: simplify deprecation language Change instances of `foo has been deprecated` to `foo is deprecated` and similar. --- doc/api/crypto.md | 2 +- doc/api/deprecations.md | 8 ++++---- doc/api/events.md | 2 +- doc/api/process.md | 2 +- doc/api/tls.md | 2 +- doc/api/util.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 5176e7c2649972..ce5fe6a6d1fc16 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1880,7 +1880,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 diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 7df44a315acf69..0b4d4986e16e64 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -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. @@ -582,7 +582,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 @@ -731,7 +731,7 @@ 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. @@ -739,7 +739,7 @@ and replaced with an identical, public `path.toNamespacedPath()` method. 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. diff --git a/doc/api/events.md b/doc/api/events.md index 0dd9e4be5dbc6d..bf57572f594d70 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -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. diff --git a/doc/api/process.md b/doc/api/process.md index 8205efbd780300..372bbe89d8a0d2 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -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 diff --git a/doc/api/tls.md b/doc/api/tls.md index 2f600fb4249f77..0e1cf39c2bcd31 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -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