DOC: Adjust deprecation procedure (#1487)

py-pdf · Dec 10, 2022 · 437aec9 · 437aec9
1 parent 7633477
commit 437aec9
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/docs/dev/deprecations.md b/docs/dev/deprecations.md
@@ -24,15 +24,16 @@ Assume the current version of PyPDF2 is `x.y.z`. After a discussion (e.g. via
 GitHub issues) we decided to remove a class / function / method. This is how
 we do it:
 
-1. `x.y.(z+1)`: Add a PendingDeprecationWarning. If there is a replacement,
+1. `x.y.(z+1)`: Add a DeprecationWarning. If there is a replacement,
    the replacement is also introduced and the warning informs about the change
    and when it will happen.
    The docs let users know about the deprecation and when it will happen and the new function.
    The CHANGELOG informs about it.
-2. `(x+1).0.0`: The PendingDeprecationWarning is changed to a DeprecationWarning.
-   The CHANGELOG informs about it.
-3. `(x+2).0.0`: The code and the DeprecationWarnings are removed.
+2. `(x+1).0.0`: Remove / change the code in the breaking way,
+   but keep/add DeprecationWarnings messages.
+   We do this to help people who didn't look at the warnings before.
    The CHANGELOG informs about it.
+3. `(x+2).0.0`: The DeprecationWarnings are removed.
 
 This means the users have 3 warnings in the CHANGELOG, a PendingDeprecationWarning
 until the next major release and a DeprecationWarning until the major release