Skip to content

PEP 387: Add Soft Deprecation section #3182

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.

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

Merged
merged 4 commits into from
Jul 3, 2023

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Jun 26, 2023


📚 Documentation preview 📚: https://pep-previews--3182.org.readthedocs.build/

@vstinner vstinner requested a review from benjaminp as a code owner June 26, 2023 12:56
@vstinner
Copy link
Member Author

@vstinner
Copy link
Member Author

@pfmoore: I addressed some of your comments.

@vstinner
Copy link
Member Author

For people interested about the exact implementation of SoftDeprecationWarning: I created the PR python/cpython#106142.

@vstinner
Copy link
Member Author

@pfmoore: I rephrased the section. Would you mind to review the updated PR?

@vstinner
Copy link
Member Author

I replaced MUST with SHOULD:

A soft deprecation can be used when using an API which must no longer be used to write new code

becomes:

A soft deprecation can be used when using an API which should no longer be used to write new code

@vstinner vstinner marked this pull request as draft June 28, 2023 03:06
@vstinner
Copy link
Member Author

I mark this PR as a draft to prevent merging it by mistake. I will request SC approval to merge it once it will be ready.

Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better, thanks. I've suggested one minor change.

@pfmoore
Copy link
Member

pfmoore commented Jun 28, 2023

Also, note the discussion on Discourse is still ongoing - I favour the idea of removing the association between "deprecated" and "scheduled for removal", in favour of explicitly flagging things that are planned for removal.

@vstinner
Copy link
Member Author

I updated the PR to no longer issue a warning.

@vstinner
Copy link
Member Author

I submitted this PEP change to the Steering Council: python/steering-council#199

@vstinner
Copy link
Member Author

vstinner commented Jul 3, 2023

"The SC agrees with the proposal and accepts the PEP update": python/steering-council#199 (comment)

@vstinner vstinner marked this pull request as ready for review July 3, 2023 19:23
@vstinner vstinner requested a review from a team as a code owner July 3, 2023 19:23
@vstinner vstinner merged commit 57b1d94 into python:main Jul 3, 2023
@vstinner vstinner deleted the soft-deprecation branch July 3, 2023 19:25
@vstinner
Copy link
Member Author

vstinner commented Jul 3, 2023

Thanks for the reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants