Commit f2c2f42
doc: improve wording in deprecations.md
* utilize -> use
* may -> can/might as appropriate
PR-URL: #34860
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent e90cb49 commit f2c2f42
1 file changed
Lines changed: 8 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,13 +3,13 @@ | |||
| 3 | 3 | <!--introduced_in=v7.7.0--> | |
| 4 | 4 | <!-- type=misc --> | |
| 5 | 5 | ||
| 6 | - Node.js may deprecate APIs for any of the following reasons: | ||
| 6 | + Node.js APIs might be deprecated for any of the following reasons: | ||
| 7 | 7 | ||
| 8 | 8 | * Use of the API is unsafe. | |
| 9 | 9 | * An improved alternative API is available. | |
| 10 | 10 | * Breaking changes to the API are expected in a future major release. | |
| 11 | 11 | ||
| 12 | - Node.js utilizes three kinds of Deprecations: | ||
| 12 | + Node.js uses three kinds of Deprecations: | ||
| 13 | 13 | ||
| 14 | 14 | * Documentation-only | |
| 15 | 15 | * Runtime | |
@@ -34,7 +34,7 @@ from Node.js. | |||
| 34 | 34 | ||
| 35 | 35 | ## Revoking deprecations | |
| 36 | 36 | ||
| 37 | - Occasionally, the deprecation of an API may be reversed. In such situations, | ||
| 37 | + Occasionally, the deprecation of an API might be reversed. In such situations, | ||
| 38 | 38 | this document will be updated with information relevant to the decision. | |
| 39 | 39 | However, the deprecation identifier will not be modified. | |
| 40 | 40 | ||
@@ -1651,7 +1651,7 @@ Type: End-of-Life | |||
| 1651 | 1651 | Using a property named `inspect` on an object to specify a custom inspection | |
| 1652 | 1652 | function for [`util.inspect()`][] is deprecated. Use [`util.inspect.custom`][] | |
| 1653 | 1653 | instead. For backward compatibility with Node.js prior to version 6.4.0, both | |
| 1654 | - may be specified. | ||
| 1654 | + can be specified. | ||
| 1655 | 1655 | ||
| 1656 | 1656 | <a id="DEP0080"></a> | |
| 1657 | 1657 | ### DEP0080: `path._makeLong()` | |
@@ -1752,7 +1752,7 @@ The `v8/*` modules do not have any exports, and if not imported in a specific | |||
| 1752 | 1752 | order would in fact throw errors. As such there are virtually no legitimate use | |
| 1753 | 1753 | cases for importing them through `require()`. | |
| 1754 | 1754 | ||
| 1755 | - On the other hand, `node-inspect` may be installed locally through a package | ||
| 1755 | + On the other hand, `node-inspect` can be installed locally through a package | ||
| 1756 | 1756 | manager, as it is published on the npm registry under the same name. No source | |
| 1757 | 1757 | code modification is necessary if that is done. | |
| 1758 | 1758 | ||
@@ -2053,7 +2053,7 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) | |||
| 2053 | 2053 | ||
| 2054 | 2054 | When assigning a non-string property to [`process.env`][], the assigned value is | |
| 2055 | 2055 | implicitly converted to a string. This behavior is deprecated if the assigned | |
| 2056 | - value is not a string, boolean, or number. In the future, such assignment may | ||
| 2056 | + value is not a string, boolean, or number. In the future, such assignment might | ||
| 2057 | 2057 | result in a thrown error. Please convert the property to a string before | |
| 2058 | 2058 | assigning it to `process.env`. | |
| 2059 | 2059 | ||
@@ -2249,7 +2249,7 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) | |||
| 2249 | 2249 | In recent versions of Node.js, there is no difference between | |
| 2250 | 2250 | [`crypto.randomBytes()`][] and `crypto.pseudoRandomBytes()`. The latter is | |
| 2251 | 2251 | deprecated along with the undocumented aliases `crypto.prng()` and | |
| 2252 | - `crypto.rng()` in favor of [`crypto.randomBytes()`][] and may be removed in a | ||
| 2252 | + `crypto.rng()` in favor of [`crypto.randomBytes()`][] and might be removed in a | ||
| 2253 | 2253 | future release. | |
| 2254 | 2254 | ||
| 2255 | 2255 | <a id="DEP0116"></a> | |
@@ -2600,7 +2600,7 @@ changes: | |||
| 2600 | 2600 | Type: Runtime | |
| 2601 | 2601 | ||
| 2602 | 2602 | Allowing a [`fs.FileHandle`][] object to be closed on garbage collection is | |
| 2603 | - deprecated. In the future, doing so may result in a thrown error that will | ||
| 2603 | + deprecated. In the future, doing so might result in a thrown error that will | ||
| 2604 | 2604 | terminate the process. | |
| 2605 | 2605 | ||
| 2606 | 2606 | Please ensure that all `fs.FileHandle` objects are explicitly closed using | |
0 commit comments