1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: simplify deprecation language

Browse Source 
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>
This commit is contained in:
Rich Trott 2018-06-04 11:58:47 -07:00
parent cdd2e96a2d
commit 1252907c6c
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/crypto.md
View File

@ -1880,7 +1880,7 @@ console.log(key.toString('hex')); // '3745e48...08d59ae'
``` ```
The `crypto.DEFAULT_ENCODING` property may be used to change the way the 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. should be avoided.
```js ```js

8
doc/api/deprecations.md
View File

@ -192,7 +192,7 @@ The [`fs.readSync()`][] legacy `String` interface is deprecated. Use the
Type: Runtime 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. and should no longer be used.
<a id="DEP0017"></a> <a id="DEP0017"></a>
@ -582,7 +582,7 @@ removed. Please use `sloppy` instead.
Type: Documentation-only Type: Documentation-only
The `http` module `outgoingMessage._headers` and `outgoingMessage._headerNames` 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()`, (e.g. `outgoingMessage.getHeader()`, `outgoingMessage.getHeaders()`,
`outgoingMessage.getHeaderNames()`, `outgoingMessage.hasHeader()`, `outgoingMessage.getHeaderNames()`, `outgoingMessage.hasHeader()`,
`outgoingMessage.removeHeader()`, `outgoingMessage.setHeader()`) for working `outgoingMessage.removeHeader()`, `outgoingMessage.setHeader()`) for working
@ -731,7 +731,7 @@ may be specified.
Type: Documentation-only Type: Documentation-only
The internal `path._makeLong()` was not intended for public use. However, 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. and replaced with an identical, public `path.toNamespacedPath()` method.
<a id="DEP0081"></a> <a id="DEP0081"></a>
@ -739,7 +739,7 @@ and replaced with an identical, public `path.toNamespacedPath()` method.
Type: Runtime 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 deprecated. Please use `fs.ftruncate()` or `fs.ftruncateSync()` to work with
file descriptors. file descriptors.

2
doc/api/events.md
View File

@ -142,7 +142,7 @@ myEmitter.emit('error', new Error('whoops!'));
``` ```
To guard against crashing the Node.js process the [`domain`][] module can be 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. As a best practice, listeners should always be added for the `'error'` events.

2
doc/api/process.md
View File

@ -205,7 +205,7 @@ added: v1.4.1
changes: changes:
- version: v7.0.0 - version: v7.0.0
pr-url: https://github.com/nodejs/node/pull/8217 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 - version: v6.6.0
pr-url: https://github.com/nodejs/node/pull/8223 pr-url: https://github.com/nodejs/node/pull/8223
description: Unhandled `Promise` rejections will now emit description: Unhandled `Promise` rejections will now emit

2
doc/api/tls.md
View File

@ -1269,7 +1269,7 @@ deprecated: v0.11.3
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead. > Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
The `tls.CryptoStream` class represents a stream of encrypted data. This class 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 #### cryptoStream.bytesWritten
<!-- YAML <!-- YAML

2
doc/api/util.md
View File

@ -1590,7 +1590,7 @@ util.types.isWebAssemblyCompiledModule(module); // Returns true
## Deprecated APIs ## 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. applications and modules should be updated to find alternative approaches.
### util.\_extend(target, source) ### util.\_extend(target, source)