Skip to content
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.

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

gh-95913: Prepare remaining Whatsnew sections for editing #98342

Merged
merged 4 commits into from
Oct 18, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Oct 16, 2022

Part of #95913

To ensure PRs to edit the remaining sections can all be submitted in parallel and don't introduce any merge conflicts with each other, this preliminary PR (which can hopefully be merged quickly) ensures there are two line breaks between each section (per standard convention), and adds the same standard ref target labels to each section as the previous to enable stable cross-referencing.

To note, this PR does not do so for any of the Improved Modules subsections, which will be done in a separate PR once the current batch of PRs adding/editing those are merged, so the rest can safely proceed in parallel without conflicts.

Additionally, it makes a few other straightforward but cross-cutting changes:

  • Elide the redundant "Python API changes" subsection heading in the Porting section, given all the C API changes are discussed under the C API section
  • Move the list of C APIs pending deprecation from the top-level Pending Removal section to a subsection of the C API section, to match all the others (Deprecated/Removed/Porting), and mention/link it accordingly
  • Explicitly clarify that the top-level Deprecated/Pending Removal/Removed/Porting-section changes are referring to the Python API, and link the C API equivalents
  • Use the standard H4 heading underbar symbols as stated in the devguide

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 16, 2022
@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 16, 2022
@CAM-Gerlach CAM-Gerlach changed the title bpo-95913: Prepare remaining Whatsnew sections for editing gh-95913: Prepare remaining Whatsnew sections for editing Oct 16, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 16, 2022
33 tasks
@ezio-melotti ezio-melotti merged commit 0a0c7e5 into python:main Oct 18, 2022
@miss-islington
Copy link
Contributor

Thanks @CAM-Gerlach for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 18, 2022
…onGH-98342)

* Add line breaks & ref targets to Whatsnew to prepare for future changes

* Use standard heading underbar symbols for H4 sections

* Flatten Porting subsection; clarify scope of/link Python->CAPI sections

* Move C API pending deprecations to C API section, to match the others
(cherry picked from commit 0a0c7e5)

Co-authored-by: C.A.M. Gerlach <[email protected]>
@bedevere-bot
Copy link

GH-98384 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 18, 2022
miss-islington added a commit that referenced this pull request Oct 18, 2022
* Add line breaks & ref targets to Whatsnew to prepare for future changes

* Use standard heading underbar symbols for H4 sections

* Flatten Porting subsection; clarify scope of/link Python->CAPI sections

* Move C API pending deprecations to C API section, to match the others
(cherry picked from commit 0a0c7e5)

Co-authored-by: C.A.M. Gerlach <[email protected]>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
* Add line breaks & ref targets to Whatsnew to prepare for future changes

* Use standard heading underbar symbols for H4 sections

* Flatten Porting subsection; clarify scope of/link Python->CAPI sections

* Move C API pending deprecations to C API section, to match the others
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants