From ae2175e3b2f110feda43a8b4fcc8c610545217c0 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:03:13 -0400 Subject: [PATCH 1/2] APE 2: Clarify next major release meaning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit in deprecation policy. Co-authored-by: Brigitta Sipőcz --- APE2.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/APE2.rst b/APE2.rst index e899b21e..fd0e3119 100644 --- a/APE2.rst +++ b/APE2.rst @@ -137,7 +137,8 @@ The guidelines in relation to API changes and backward compatibility are as foll * New deprecations should not be introduced in bugfix releases. * If developers wish to make an API change at a point in time where the next release is a major release, they should introduce the deprecation in the major - release and carry out the change in the following major release. + release and carry out the change in the following major release + (i.e., the second feature release after deprecation). * The following will not be considered to be part of the API and can therefore be changed in bugfix and minor releases: From cda56d175e917fa846fcf1350bfdc0b34022232f Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:36:33 -0400 Subject: [PATCH 2/2] APE 2: Rephrase based on feedback --- APE2.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/APE2.rst b/APE2.rst index fd0e3119..67831223 100644 --- a/APE2.rst +++ b/APE2.rst @@ -138,7 +138,7 @@ The guidelines in relation to API changes and backward compatibility are as foll * If developers wish to make an API change at a point in time where the next release is a major release, they should introduce the deprecation in the major release and carry out the change in the following major release - (i.e., the second feature release after deprecation). + (i.e., the next x.0.0 that is at least a year away). * The following will not be considered to be part of the API and can therefore be changed in bugfix and minor releases: