summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-06-04 11:58:47 -0700
committerRich Trott <rtrott@gmail.com>2018-06-06 21:06:13 -0700
commit1252907c6c182b46248de87c515eca468257631d (patch)
tree9fdda15767c4190b88ceb608ea5c37ed7f3219ad /doc/api
parentcdd2e96a2dfe4022cb7e24aa71b9d40c43ff8102 (diff)
downloadandroid-node-v8-1252907c6c182b46248de87c515eca468257631d.tar.gz
android-node-v8-1252907c6c182b46248de87c515eca468257631d.tar.bz2
android-node-v8-1252907c6c182b46248de87c515eca468257631d.zip
doc: simplify deprecation language
Change instances of `foo has been deprecated` to `foo is deprecated` and similar. PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/crypto.md2
-rw-r--r--doc/api/deprecations.md8
-rw-r--r--doc/api/events.md2
-rw-r--r--doc/api/process.md2
-rw-r--r--doc/api/tls.md2
-rw-r--r--doc/api/util.md2
6 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 5176e7c264..ce5fe6a6d1 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 7df44a315a..0b4d4986e1 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.
<a id="DEP0017"></a>
@@ -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.
<a id="DEP0081"></a>
@@ -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 0dd9e4be5d..bf57572f59 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 92b39d6da4..16116a3206 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 2f600fb424..0e1cf39c2b 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
<!-- YAML
diff --git a/doc/api/util.md b/doc/api/util.md
index 5374fe0f49..db0790f7ea 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -1590,7 +1590,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)