Skip to content

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

Merged
AA-Turner merged 9 commits into
python:mainfrom
andresdelfino:simplify_soft_deprecated
Oct 6, 2024
Merged

Doc: Simplify the definition of 'soft deprecated'#124988
AA-Turner merged 9 commits into
python:mainfrom
andresdelfino:simplify_soft_deprecated

Conversation

@andresdelfino

@andresdelfino andresdelfino commented Oct 4, 2024

Copy link
Copy Markdown
Contributor

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 left a comment

Copy link
Copy Markdown
Member

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

Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
@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
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@andresdelfino

Copy link
Copy Markdown
Contributor Author

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

@skirpichev skirpichev left a comment

Copy link
Copy Markdown
Member

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).

Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

@willingc willingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

Comment thread Doc/glossary.rst Outdated
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

@AA-Turner AA-Turner left a comment

Copy link
Copy Markdown
Member

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.

Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
@AA-Turner AA-Turner enabled auto-merge (squash) October 6, 2024 22:03
Comment thread Doc/glossary.rst Outdated
Comment thread Doc/glossary.rst Outdated
@AA-Turner AA-Turner merged commit feca4cf into python:main Oct 6, 2024
@miss-islington-app

Copy link
Copy Markdown

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
(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@miss-islington-app

Copy link
Copy Markdown

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

bedevere-app Bot commented Oct 6, 2024

Copy link
Copy Markdown

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
…4988)

(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@bedevere-app

bedevere-app Bot commented Oct 6, 2024

Copy link
Copy Markdown

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
…125030)

(cherry picked from commit feca4cf)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Yhg1s pushed a commit that referenced this pull request Oct 6, 2024
…125029)

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

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@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

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants