Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Adjust deprecation procedure #1487

Merged
merged 1 commit into from Dec 10, 2022
Merged

DOC: Adjust deprecation procedure #1487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/dev/deprecations.md
View file
Open in desktop
Expand Up @@ -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
Expand Down