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 — Docs: move deprecations into include files · Issue #122085 · python/cpython

Docs: move deprecations into include files #122085

New issue
Copy link
New issue
Copy link
Closed
Closed
Docs: move deprecations into include files#122085
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@hugovk
hugovk
opened on Jul 21, 2024
Issue body actions

Documentation

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

To avoid needing to duplicate and sync the deprecation sections across What's New files, and ease backports, move them into include files.

  • Python:
    • Use include files for whatsnew/3.12.rst deprecations
    • Use include files for whatsnew/3.13.rst deprecations
    • Use include files for whatsnew/3.14.rst deprecations
  • C API:
    • Use include files for deprecations
  • Create dedicated page to list deprecations using include files

Linked PRs

  • gh-122085: Use include files for whatsnew/3.13.rst deprecations #121241
  • [3.13] gh-122085: Use include files for whatsnew/3.13.rst deprecations (GH-121241) #122038
  • gh-122085: Use include files for whatsnew/3.12.rst deprecations #122093
  • [3.13] gh-122085: Use include files for whatsnew/3.12.rst deprecations (GH-122093) #122223
  • [3.13] gh-122085: Use include files for whatsnew/3.12.rst deprecations, including 3.16 (GH-122093) #122225
  • [3.12] gh-122085: Use include files for whatsnew/3.12.rst deprecations (GH-122093) #122224
  • gh-122085: Use include files for whatsnew/3.14.rst deprecations #122242
  • [3.13] gh-122085: Use include files for whatsnew/3.14.rst deprecations (GH-122242) #122350
  • [3.12] gh-122085: Use include files for whatsnew/3.14.rst deprecations (GH-122242) #122351
  • gh-122085: Use include files for C API deprecations #109843
  • gh-122085: Create dedicated page for deprecations #122352
  • [3.13] gh-122085: Create dedicated page for deprecations (GH-122352) #122374
  • [3.12] gh-122085: Create dedicated page for deprecations (GH-122352) #122375
  • [3.13] GH-122085: Use include files for C API deprecations (GH-109843) #122422
  • [3.12] GH-122085: Use include files for C API deprecations (GH-109843) #122423
Reacted by Itamar Oren

Activity

  1. hugovk
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Jul 21, 2024
  2. hugovk
    added 6 commits that reference this issue on Jul 24, 2024

    gh-122085: Use include files for `whatsnew/3.12.rst` deprecations (#1…

    b3b7b7d

    [3.13] pythongh-122085: Use include files for `whatsnew/3.12.rst` dep…

    90b2929

    [3.13] gh-122085: Use include files for `whatsnew/3.12.rst` deprecati…

    bde9df8

    [3.12] pythongh-122085: Use include files for `whatsnew/3.12.rst` dep…

    aa9243e

    [3.13] gh-122085: Use include files for `whatsnew/3.12.rst` deprecati…

    a68237c

    [3.12] gh-122085: Use include files for `whatsnew/3.12.rst` deprecati…

    1a104e5
  3. nohlson
    added 2 commits that reference this issue on Jul 24, 2024

    pythongh-122085: Use include files for `whatsnew/3.12.rst` deprecatio…

    fa8bf4b

    pythongh-122085: Use include files for `whatsnew/3.12.rst` deprecatio…

    58f639d
  4. hugovk
    added 6 commits that reference this issue on Jul 27, 2024

    gh-122085: Use include files for `whatsnew/3.14.rst` deprecations (#1…

    4e75509

    [3.13] pythongh-122085: Use include files for `whatsnew/3.14.rst` dep…

    e9b1dc4

    [3.12] pythongh-122085: Use include files for `whatsnew/3.14.rst` dep…

    e9413b4

    [3.13] gh-122085: Use include files for `whatsnew/3.14.rst` deprecati…

    6496ffa

    [3.12] gh-122085: Use include files for `whatsnew/3.14.rst` deprecati…

    fb2826a

    gh-122085: Create dedicated page for deprecations (#122352)

    aa449cf
  5. miss-islington
    added 2 commits that reference this issue on Jul 28, 2024

    pythongh-122085: Create dedicated page for deprecations (pythonGH-122352

    957d34f

    pythongh-122085: Create dedicated page for deprecations (pythonGH-122352

    f41c7e3
  6. hugovk
    added 2 commits that reference this issue on Jul 28, 2024

    [3.13] gh-122085: Create dedicated page for deprecations (GH-122352) (#…

    c9b7e2d

    [3.12] gh-122085: Create dedicated page for deprecations (GH-122352) (#…

    ccb4e3b
  7. AA-Turner
    added 3 commits that reference this issue on Jul 29, 2024

    GH-122085: Use include files for C API deprecations (#109843)

    76bdfa4

    [3.13] pythonGH-122085: Use include files for C API deprecations (pyt…

    6b47b87

    [3.12] pythonGH-122085: Use include files for C API deprecations (pyt…

    53d629a
  8. AA-Turner commented on Jul 29, 2024

    @AA-Turner
    AA-Turner
    on Jul 29, 2024
    Member
    More actions

    Anything left outstanding?

    A

  9. hugovk commented on Jul 29, 2024

    @hugovk
    hugovk
    on Jul 29, 2024
    MemberAuthor
    More actions

    @ezio-melotti and @encukou discussed some rearrangements in #121241 (comment), now is a good time for that. What did you have in mind?

  10. AA-Turner
    added 2 commits that reference this issue on Jul 29, 2024

    [3.13] GH-122085: Use include files for C API deprecations (GH-109843) (

    56340ee

    [3.12] GH-122085: Use include files for C API deprecations (GH-109843) (

    dd86217
  11. ezio-melotti commented on Jul 30, 2024

    @ezio-melotti
    ezio-melotti
    on Jul 30, 2024
    Member
    More actions

    What did you have in mind?

    I'm looking at the ToC of What's new in 3.13, which looks like:

    ...
    Optimizations
    Removed Modules And APIs
        ...
    New Deprecations
        Pending Removal in Python 3.14
        Pending Removal in Python 3.15
        Pending Removal in Python 3.16
        Pending Removal in Future Versions
    CPython Bytecode Changes
    C API Changes
        New Features
    Build Changes
    Porting to Python 3.13
        Changes in the Python API
        Changes in the C API
        Removed C APIs
        Deprecated C APIs
        Pending Removal in Python 3.14
        Pending Removal in Python 3.15
        Pending Removal in Future Versions
    Regression Test Changes
    ...
    

    There are a few issues here:

    1. The "Pending Removal"s don't seem to belong under "New Deprecations", assuming they also include existing deprecations carried over from previous versions.
    2. It also seems that some (all?) new deprecations are also duplicated under the "Pending Removal"s.
    3. All these sections except "Pending Removal in Future Versions" have no introductory paragraph to explain briefly what are they listing (possibly including the fact that some entries are duplicated and that old deprecations are included too).
    4. Under "Porting to Python 3.13" there's another set of "Pending Removal"s, with no clear indication of the difference with the previous set. Since the title is the same, it creates a conflict in the link fragment (and the fragment is replaced by an #idxx)
    5. This part also doesn't mirror the previous one, with "Deprecated C APIs" seemingly being the C equivalent of the previous "New Deprecations", even though it's now on the same level.
    6. This new set of "Pending Removal"s seems to be about C APIs, but this is not clear from the title, and it's also not explicitly mentioned in the sections themselves.
    7. The "Porting to Python 3.13" section should arguably also contains the first set of "Pending Removal"s, or maybe both sets should be moved before and referenced where needed.
    8. "Pending Removal in Python 3.16" is missing from the second set (maybe intentionally if there are no new deprecations? should it still be added with a short note stating that there are currently no deprecations about features removed in 3.16?)

    Taking a step back, we might want to separate both Python changes from C changes (this applies to rest too) or new vs existing deprecations (this only applies to deprecation), i.e.:

    Python changes
      New APIs
      Deprecations
         New Deprecations
         Pending removal in 3.x
         Pending removal in future versions
    C changes
      New APIs
      Deprecations
         New Deprecations
         Pending removal in 3.x
         Pending removal in future versions
    

    or

    ...
    New APIs
      Python APIs
      C APIs
    Deprecations
      New Deprecations
        Python Deprecations
        C Deprecations
      Pending removal in 3.x
        Python
        C
      ...
      Pending removal in future versions
        Python
        C
    

    IOW, either the structure of the document is confusing (and should be fixed), or I am misunderstanding it (which probably means that it's confusing (and should be fixed)).

    Reacted by Petr Viktorin
  12. hugovk commented on Jan 22, 2025

    @hugovk
    hugovk
    on Jan 22, 2025
    MemberAuthor
    More actions

    I've done what I initially intended with this issue am not planning on working further on this, @ezio-melotti please open a new issue for #122085 (comment) or parts of it, if you'd like to take those forward. Thanks!

  13. hugovk
    closed this as completedon Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      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.