From 939321632c838040a9a414cb77ae9019a4f589ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Fri, 4 Oct 2024 19:49:34 -0300 Subject: [PATCH 1/8] Simplify Soft deprecated definition --- Doc/glossary.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index c9d3eba66b07d9..dc85f289872e2c 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1160,16 +1160,16 @@ Glossary (subscript) notation uses :class:`slice` objects internally. soft deprecated - A soft deprecation can be used when using an API which should no longer - be used to write new code, but it remains safe to continue using it in - existing code. The API remains documented and tested, but will not be - developed further (no enhancement). + A soft deprecated API should not + be used on new code, but it is safe for already existing code to use it. + The API remains documented and tested, but will not be + enhanced further. - The main difference between a "soft" and a (regular) "hard" deprecation - is that the soft deprecation does not imply scheduling the removal of the + The main difference with a regular deprecation + is that the soft deprecation does not schedule the removal of the deprecated API. - Another difference is that a soft deprecation does not issue a warning. + Another difference is that the use a soft deprecated API does not issue a warning. See `PEP 387: Soft Deprecation `_. From 22814511f6e9bb1a928350125088d459187d1501 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Fri, 4 Oct 2024 19:59:23 -0300 Subject: [PATCH 2/8] Simplify Soft deprecated definition --- Doc/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index dc85f289872e2c..5c903810d2f562 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1167,7 +1167,7 @@ Glossary The main difference with a regular deprecation is that the soft deprecation does not schedule the removal of the - deprecated API. + API. Another difference is that the use a soft deprecated API does not issue a warning. From 02de9c856598fe4708589b25b12118c19da4433f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Fri, 4 Oct 2024 20:23:10 -0300 Subject: [PATCH 3/8] Update Doc/glossary.rst Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- Doc/glossary.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 5c903810d2f562..d0ba38a2ce8952 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1165,9 +1165,8 @@ Glossary The API remains documented and tested, but will not be enhanced further. - The main difference with a regular deprecation - is that the soft deprecation does not schedule the removal of the - API. + The main difference from a normal deprecation + is that soft deprecation does not plan on removing the API. Another difference is that the use a soft deprecated API does not issue a warning. From 3163124be97cac565a013d39a683199e023e2182 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Fri, 4 Oct 2024 20:25:01 -0300 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- Doc/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index d0ba38a2ce8952..c5fc4620af9969 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1161,14 +1161,14 @@ Glossary soft deprecated A soft deprecated API should not - be used on new code, but it is safe for already existing code to use it. + be used in new code, but it is safe for already existing code to use it. The API remains documented and tested, but will not be enhanced further. The main difference from a normal deprecation is that soft deprecation does not plan on removing the API. - Another difference is that the use a soft deprecated API does not issue a warning. + Another difference is that soft deprecated APIs don't emit warnings. See `PEP 387: Soft Deprecation `_. From 46287d4c9d17f1d685b3131fc79d90e0a5d98510 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Sat, 5 Oct 2024 09:58:21 -0300 Subject: [PATCH 5/8] Apply suggestions from code review Co-authored-by: Sergey B Kirpichev --- Doc/glossary.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index c5fc4620af9969..567a1da2b59e3d 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1160,13 +1160,12 @@ Glossary (subscript) notation uses :class:`slice` objects internally. soft deprecated - A soft deprecated API should not - be used in new code, but it is safe for already existing code to use it. - The API remains documented and tested, but will not be - enhanced further. + A soft deprecated API should not be used in new code, but it is + safe for already existing code to use it. The API remains + documented and tested, but will not be enhanced further. - The main difference from a normal deprecation - is that soft deprecation does not plan on removing the API. + The main difference from a normal deprecation is that soft + deprecation does not plan on removing the API. Another difference is that soft deprecated APIs don't emit warnings. From 8b0d89835fa3b9f7b2b480caa92df1db0f9aa3a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Sun, 6 Oct 2024 18:58:46 -0300 Subject: [PATCH 6/8] Update Doc/glossary.rst Co-authored-by: Carol Willing --- Doc/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 567a1da2b59e3d..3bf1906affd443 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1164,8 +1164,8 @@ Glossary safe for already existing code to use it. The API remains documented and tested, but will not be enhanced further. - The main difference from a normal deprecation is that soft - deprecation does not plan on removing the API. + Soft deprecation, unlike normal deprecation, does not plan on removing the API and + will not emit warnings. Another difference is that soft deprecated APIs don't emit warnings. From f609818905578eba5057f396517af9ea32313196 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sun, 6 Oct 2024 23:03:34 +0100 Subject: [PATCH 7/8] Final edits --- Doc/glossary.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 3bf1906affd443..dc7ac763780c40 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1160,14 +1160,12 @@ Glossary (subscript) notation uses :class:`slice` objects internally. soft deprecated - A soft deprecated API should not be used in new code, but it is - safe for already existing code to use it. The API remains - documented and tested, but will not be enhanced further. + A soft deprecated API should not be used in new code, + but it is safe for already existing code to use it. + The API remains documented and tested, but will not be enhanced further. - Soft deprecation, unlike normal deprecation, does not plan on removing the API and - will not emit warnings. - - Another difference is that soft deprecated APIs don't emit warnings. + Soft deprecation, unlike normal deprecation, does not plan on removing the API + and will not emit warnings. See `PEP 387: Soft Deprecation `_. From 6f12c0f452393205b4f8d928086af31fd6d3b5e9 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sun, 6 Oct 2024 23:04:46 +0100 Subject: [PATCH 8/8] Whitespace --- Doc/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index dc7ac763780c40..e72a8d002d507d 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1160,11 +1160,11 @@ Glossary (subscript) notation uses :class:`slice` objects internally. soft deprecated - A soft deprecated API should not be used in new code, + A soft deprecated API should not be used in new code, but it is safe for already existing code to use it. The API remains documented and tested, but will not be enhanced further. - Soft deprecation, unlike normal deprecation, does not plan on removing the API + Soft deprecation, unlike normal deprecation, does not plan on removing the API and will not emit warnings. See `PEP 387: Soft Deprecation