Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add a guide to deprecating features #1469

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

Draft
Lincoln-developer wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Add a guide to deprecating features #1469

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f2fd360
Added deprecation workflow in CPython.
Lincoln-developer Nov 8, 2024
e99387d
Fixed sphinx-linting error
Lincoln-developer Nov 8, 2024
be9224b
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
b8fbd0b
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
207294f
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
a90e99a
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
fc0b4ec
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
7029868
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
0dc75ec
Update developer-workflow/cpython-deprecation-workflow.rst
Lincoln-developer Nov 8, 2024
0d8bd61
fixed requested changes
Lincoln-developer Nov 8, 2024
d077a58
fixed required warning function
Lincoln-developer Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update developer-workflow/cpython-deprecation-workflow.rst 
Co-authored-by: Adam Turner <[email protected]>
  • Loading branch information
@Lincoln-developer @AA-Turner
Lincoln-developer and AA-Turner authored Nov 8, 2024
commit 0dc75ec7d1b2c340e38c9cb127e87ff9e963da24
7 changes: 4 additions & 3 deletions developer-workflow/cpython-deprecation-workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ For gradual deprecations:
* Mention the pending deprecation in “What’s New.”
* No ``pending-removal-in`` entry is needed during this stage.

7. References and Templates
---------------------------
* Use ``.. deprecated::`` and ``.. removed::`` Sphinx roles for documentation.
References and templates
------------------------
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Sep 8, 2025

Choose a reason for hiding this comment

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

We can also link to PEP 4


* Use the ``.. deprecated-removed::`` roles for documentation.
* Add ``See Also`` links to :pep:`387` and DevGuide for policy and process details.
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Sep 8, 2025

Choose a reason for hiding this comment

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

I don't understand, do you suggest a .. see-also:: under every deprecated feature?