Skip to content

Doc: Simplify the definition of 'soft deprecated' #124988

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
Merged
merged 9 commits into from
Oct 6, 2024
Merged

Doc: Simplify the definition of 'soft deprecated' #124988

merged 9 commits into from
Oct 6, 2024

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Oct 4, 2024 •
edited
Loading

I found the definition of Soft deprecated somewhat complicated, and I wanted to give it a try.

The violation of line max width is intentional, as I was once told it's better for diff purposes, until merge.

📚 Documentation preview 📚: https://cpython-previews--124988.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 4, 2024
AA-Turner
AA-Turner reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This is a good start towards a rewrite, thank you. I've suggested some further improvements inline:

The violation of line max width is intentional, as I once told it's better for diff purposes, at least in the PR stage.

This is fine but we should re-wrap before merge.

A

@AA-Turner AA-Turner added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Oct 4, 2024
@AA-Turner AA-Turner changed the title Simplify Soft deprecated definition Doc: Simplify the definition of 'soft deprecated' Oct 4, 2024
andresdelfino and others added 2 commits October 4, 2024 20:23
@andresdelfino
Copy link
Contributor Author

@AA-Turner Thanks for the review! I have addressed all comments. Sorry if you already received a notification 😅

skirpichev
skirpichev approved these changes Oct 5, 2024
View reviewed changes
Copy link
Member

@skirpichev skirpichev left a comment

Choose a reason for hiding this comment

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

LGTM, modulo two nitpicks (run fill-region in emacs, feel free to ignore).

PS: @andresdelfino, please avoid "Update branch" button, unless you are fixing merge conflicts or something like that (https://devguide.python.org/getting-started/pull-request-lifecycle/#update-branch-button).

@andresdelfino @skirpichev
Apply suggestions from code review
46287d4 
Co-authored-by: Sergey B Kirpichev <[email protected]>
willingc
willingc reviewed Oct 6, 2024
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks!

@andresdelfino @willingc
Update Doc/glossary.rst
8b0d898 
Co-authored-by: Carol Willing <[email protected]>
AA-Turner
AA-Turner approved these changes Oct 6, 2024
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Remove the final sentence per Carol and re-wrap.

@AA-Turner AA-Turner enabled auto-merge (squash) October 6, 2024 22:03
AA-Turner
AA-Turner reviewed Oct 6, 2024
View reviewed changes
@AA-Turner AA-Turner merged commit feca4cf into python:main Oct 6, 2024
23 checks passed
@miss-islington-app
Copy link

Thanks @andresdelfino for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 6, 2024
@andresdelfino @AA-Turner
@skirpichev @willingc @miss-islington
Doc: Simplify the definition of 'soft deprecated' (pythonGH-124988)
a7a461f 
(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Sergey B Kirpichev <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
@miss-islington-app
Copy link

Sorry, @andresdelfino and @AA-Turner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker feca4cf64e9742b9c002d5533ced47e68b34a880 3.12

@bedevere-app
Copy link

bedevere-app bot commented Oct 6, 2024

GH-125029 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 6, 2024
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Oct 6, 2024
@andresdelfino @AA-Turner
@skirpichev @willingc
[3.12] Doc: Simplify the definition of 'soft deprecated' (pythonGH-12…
fe92808 
…4988)

(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Sergey B Kirpichev <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 6, 2024

GH-125030 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 6, 2024
AA-Turner added a commit that referenced this pull request Oct 6, 2024
@AA-Turner @andresdelfino
@skirpichev @willingc
[3.12] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#…
73d7393 
…125030)

(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <[email protected]>
Co-authored-by: Sergey B Kirpichev <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
Yhg1s pushed a commit that referenced this pull request Oct 6, 2024
@miss-islington @andresdelfino
@AA-Turner @skirpichev @willingc
[3.13] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#…
d7e4c79 
…125029)

Doc: Simplify the definition of 'soft deprecated' (GH-124988)
(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Sergey B Kirpichev <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
@andresdelfino andresdelfino deleted the simplify_soft_deprecated branch October 7, 2024 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willingc willingc willingc left review comments

@AA-Turner AA-Turner AA-Turner approved these changes

@skirpichev skirpichev skirpichev approved these changes

Assignees

@AA-Turner AA-Turner

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@andresdelfino @skirpichev @willingc @AA-Turner