GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-122085: Use include files for `whatsnew/3.13.rst` deprecations by hugovk · Pull Request #121241 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Jul 1, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Re: https://discuss.python.org/t/streamline-whats-new-by-moving-deprecations-and-removals-out-of-news/53997/8

This moves these sections out of "What's New in Python 3.13" into include files:

  • "Pending Removal in Python 3.14"
  • "Pending Removal in Python 3.15"
  • "Pending Removal in Future Versions"

Later PRs will add includes to other What's New files, to avoid needing to duplicate and sync these sections between files. And we can later also create a dedicated page to list deprecations.


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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

nineteendo and DBJim reacted with heart emoji
All reactions
  • ❤️ 2 reactions
@hugovk hugovk added docs Documentation in the Doc dir needs backport to 3.13 only security fixes labels Jul 1, 2024
@bedevere-app bedevere-app Bot added skip news awaiting core review labels Jul 1, 2024
@hugovk hugovk added the skip issue label Jul 1, 2024
@hugovk hugovk mentioned this pull request Jul 1, 2024
gh-122085: Use include files for C API deprecations #109843
Merged
@nineteendo

nineteendo commented Jul 1, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

What happens if an entry from "Pending Removal in Future Versions" moves to "Pending Removal in Python 3.16"?
Would it be beneficial to include blank Doc/deprecations/pending-removal-in-3.*.rst up to when 3.13 will reach EOL (3.18)?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Jul 1, 2024

Copy link
Copy Markdown
Member Author

Then we move it from ../deprecations/pending-removal-in-future.rst into a .. include:: ../deprecations/pending-removal-in-3.16.rst.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nineteendo

nineteendo commented Jul 1, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Yes, but then it wouldn't show up in the list of future deprecations for 3.13 if 3.16 isn't included (which would be easy to forget when added).

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Jul 1, 2024

Copy link
Copy Markdown
Member Author

Correct, when creating a new include file, you need to remember to add it to the relevant pages.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

willingc
willingc approved these changes Jul 2, 2024
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Jul 2, 2024
@encukou

encukou commented Jul 2, 2024

Copy link
Copy Markdown
Member

This only covers the C API, not the Python API. Is that intended?

nineteendo reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Jul 2, 2024

Copy link
Copy Markdown
Member Author

TODO: This was meant to be for the Python deprecations, not C API ones. I'll update it.

nineteendo and blaisep reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nineteendo

nineteendo commented Jul 2, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

What will we do with the C API? Do we include it like this? Or do we put it in a separate file?

.. include::  ../deprecations/pending-removal-in-3.14.rst
    :start-after: .. start_pending_removal_in_3_14_capi
    :end-before: .. end_pending_removal_in_3_14_capi
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Jul 2, 2024

Copy link
Copy Markdown
Member Author

No, I think it would be easier to have each in their own files (not necessarily named like this):

deprecations/pending-removal-in-3.14.rst
deprecations/pending-removal-in-3.14_capi.rst
nineteendo and encukou reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
hugovk marked this pull request as draft July 2, 2024 19:58
@bedevere-app bedevere-app Bot removed the awaiting merge label Jul 2, 2024
@hugovk
Docs: move deprecations into include files
2e85df9
@hugovk
hugovk force-pushed the docs-include-deprecations branch from 8a461c5 to 2e85df9 Compare July 5, 2024 20:20
@hugovk

hugovk commented Jul 5, 2024

Copy link
Copy Markdown
Member Author

TODO: This was meant to be for the Python deprecations, not C API ones. I'll update it.

Updated.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
hugovk marked this pull request as ready for review July 5, 2024 20:25
@bedevere-app bedevere-app Bot added the awaiting core review label Jul 5, 2024
encukou
encukou approved these changes Jul 18, 2024
View reviewed changes

@encukou encukou left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Looks good to me, with one typo fix!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread Doc/deprecations/pending-removal-in-future.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Jul 18, 2024
ezio-melotti
ezio-melotti reviewed Jul 18, 2024
View reviewed changes
Comment thread Doc/whatsnew/3.13.rst
@@ -1631,318 +1631,13 @@ New Deprecations

.. Add deprecations above alphabetically, not here at the end.

@ezio-melotti ezio-melotti Jul 18, 2024

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Would it make sense to add a new "Pending removal" section, with a paragraph describing what "pending removal" means, and include the other files as subsections?

These are currently nested under "New Deprecation" (not sure if intentionally):
image

I also noticed that there are two "Pending Removal in Python 3.x", for each "x", e.g.:

  • https://cpython-previews--121241.org.readthedocs.build/en/121241/whatsnew/3.13.html#pending-removal-in-python-3-14
  • https://cpython-previews--121241.org.readthedocs.build/en/121241/whatsnew/3.13.html#id7

Is this intentional?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@encukou encukou Jul 19, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I suggest not expanding the scope of the PR. Move the content in this one, rearrange the page later (and possibly only for 3.14).

I also noticed that there are two "Pending Removal in Python 3.x", for each "x", e.g.:

Yes, there are separate sections for Python API and C API, and they're not presented very clearly.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@ezio-melotti ezio-melotti Aug 6, 2024

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

FWIW, I followed up on this in the original issue:

  • Docs: move deprecations into include files #122085 (comment)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
hugovk added 2 commits July 19, 2024 12:39
@hugovk
Fix typo, resolve conflict
5f68261
@hugovk
Merge branch 'main' into docs-include-deprecations
60aae19
@hugovk hugovk mentioned this pull request Jul 19, 2024
GH-121970: Use Ruff to check and format the docs tools #122018
Merged
@hugovk
hugovk merged commit a1df1b4 into python:main Jul 19, 2024
@hugovk
hugovk deleted the docs-include-deprecations branch July 19, 2024 13:57
@miss-islington-app

miss-islington-app Bot commented Jul 19, 2024

Copy link
Copy Markdown

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the awaiting merge label Jul 19, 2024
@miss-islington-app

miss-islington-app Bot commented Jul 19, 2024

Copy link
Copy Markdown

Sorry, @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker a1df1b44394784721239615f307b273455536d14 3.13
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington-app miss-islington-app Bot assigned hugovk Jul 19, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request Jul 19, 2024
@hugovk
[3.13] Docs: move deprecations into include files (pythonGH-121241)
838ef3c
(cherry picked from commit a1df1b4)

Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app

bedevere-app Bot commented Jul 19, 2024

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jul 19, 2024
hugovk added a commit that referenced this pull request Jul 19, 2024
@hugovk
[3.13] Docs: move deprecations into include files (GH-121241) (#122038)
159ea47
@ezio-melotti ezio-melotti mentioned this pull request Jul 20, 2024
Define and document a procedure for following up on reviews python/devguide#1359
Open
@hugovk hugovk changed the title Docs: move deprecations into include files Docs: move deprecations from 3.13.rst into include files Jul 21, 2024
@hugovk hugovk mentioned this pull request Jul 21, 2024
Docs: move deprecations into include files #122085
Closed
5 tasks done
@hugovk hugovk changed the title Docs: move deprecations from 3.13.rst into include files gh-122085: Docs: move deprecations from 3.13.rst into include files Jul 21, 2024
@hugovk hugovk changed the title gh-122085: Docs: move deprecations from 3.13.rst into include files gh-122085: Use include files for whatsnew/3.13.rst deprecations Jul 21, 2024
@hugovk

hugovk commented Jul 22, 2024

Copy link
Copy Markdown
Member Author

I've opened #122085 as a tracking issue, and #122093 is the next PR.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app

bedevere-app Bot commented Jul 24, 2024

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

1 similar comment
@bedevere-app

bedevere-app Bot commented Jul 24, 2024

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou approved these changes
@ezio-melotti ezio-melotti ezio-melotti left review comments
@willingc willingc willingc approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@hugovk hugovk

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.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@hugovk @nineteendo @encukou @willingc @ezio-melotti
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.