From 05f668b98ed64c77e86f7b22c9c49c94b56b8b9b Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Wed, 29 May 2019 15:57:26 -0700 Subject: [PATCH 1/6] doc: order deprecation reasons --- doc/api/deprecations.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 284df5a2886c5f..296021ec5a0982 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3,9 +3,11 @@ -Node.js may deprecate APIs when either: (a) use of the API is considered to be -unsafe, (b) an improved alternative API is available, or (c) breaking changes to -the API are expected in a future major release. +Node.js may deprecate APIs in the following cases: + +* use of the API is considered to be unsafe +* an improved alternative API is available +* breaking changes to the API are expected in a future major release. Node.js utilizes three kinds of Deprecations: From 07c4177d7ca6151b5914724de2c87eb0f1b65437 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Wed, 29 May 2019 22:06:16 -0700 Subject: [PATCH 2/6] doc: suggestion from Trott Co-Authored-By: Rich Trott --- doc/api/deprecations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 296021ec5a0982..172e4d6f8562f7 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3,7 +3,7 @@ -Node.js may deprecate APIs in the following cases: +Node.js may deprecate APIs when: * use of the API is considered to be unsafe * an improved alternative API is available From 6c231f22da61b6e1f9b0c56716a02dcdde288297 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Wed, 29 May 2019 22:09:34 -0700 Subject: [PATCH 3/6] doc: uppercase the first letter in list --- doc/api/deprecations.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 172e4d6f8562f7..ec28a9a674f399 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -5,9 +5,9 @@ Node.js may deprecate APIs when: -* use of the API is considered to be unsafe -* an improved alternative API is available -* breaking changes to the API are expected in a future major release. +* Use of the API is considered to be unsafe +* An improved alternative API is available +* Breaking changes to the API are expected in a future major release. Node.js utilizes three kinds of Deprecations: From 88c7acf3e1cbe1bac62cf34a160c180f4f158eee Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Sun, 2 Jun 2019 08:40:11 -0700 Subject: [PATCH 4/6] doc: add any of the following Co-Authored-By: Rich Trott --- doc/api/deprecations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index ec28a9a674f399..253e2131cfcf1f 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3,7 +3,7 @@ -Node.js may deprecate APIs when: +Node.js may deprecate APIs for any of the following reasons: * Use of the API is considered to be unsafe * An improved alternative API is available From 0e5235b65a2e03a77113357faca823e17d68d889 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Sun, 2 Jun 2019 13:43:08 -0700 Subject: [PATCH 5/6] Update doc/api/deprecations.md Co-Authored-By: Rich Trott --- doc/api/deprecations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 253e2131cfcf1f..c7ccab72c1e711 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -5,7 +5,7 @@ Node.js may deprecate APIs for any of the following reasons: -* Use of the API is considered to be unsafe +* Use of the API is considered to be unsafe. * An improved alternative API is available * Breaking changes to the API are expected in a future major release. From dd75200b830d6fa5f37f31457a8aba6fd29cd2ec Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Sun, 2 Jun 2019 13:43:24 -0700 Subject: [PATCH 6/6] Update doc/api/deprecations.md Co-Authored-By: Rich Trott --- doc/api/deprecations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index c7ccab72c1e711..49df1bba98b129 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -6,7 +6,7 @@ Node.js may deprecate APIs for any of the following reasons: * Use of the API is considered to be unsafe. -* An improved alternative API is available +* An improved alternative API is available. * Breaking changes to the API are expected in a future major release. Node.js utilizes three kinds of Deprecations: