Skip to content

Add concrete NEWS entry examples - #1906

Open
muhammad-a-dev wants to merge 5 commits into
python:mainfrom
muhammad-a-dev:docs-news-examples-1243
Open

muhammad-a-dev wants to merge 5 commits into
python:mainfrom
muhammad-a-dev:docs-news-examples-1243

Conversation

@muhammad-a-dev

@muhammad-a-dev muhammad-a-dev commented Sep 17, 2026

Copy link
Copy Markdown

Summary

Fixes #1243.

Inlines concrete do / don't NEWS entry examples under the existing Changes that require NEWS entries section in getting-started/pull-request-lifecycle.rst (from @ezio-melotti's review note on #1238):

  • Do need a NEWS entry: new function/method/class/module; new HOWTO; removal of a deprecated feature
  • Do not need a NEWS entry: feature cut before final release; typo in docs/docstring; new test method; private API removal; refactor with no user-visible effects

This keeps the examples with the current NEWS guidance instead of a separate sibling page.

Prerequisite #674 is already closed (NEWS guidance lives in the lifecycle page after #1506).

AI tools

Drafted with assistance from Cursor (AI); I reviewed the wording against the issue text and existing NEWS guidance before opening this PR.

@python-cla-bot

python-cla-bot Bot commented Sep 17, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

read-the-docs-community Bot commented Sep 17, 2026

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #34609262 | 📁 Comparing 267aac2 against latest (8b8b1f2)

  🔍 Preview build  

1 file changed
± getting-started/pull-request-lifecycle/index.html

@StanFromIreland

StanFromIreland commented Sep 17, 2026

Copy link
Copy Markdown
Member

Please sign the CLA, it's necessary before we can review.

This section seems to duplicate some content we have in the current section for news entries. The new proposed section also isn't linked there.

@StanFromIreland
StanFromIreland marked this pull request as draft September 17, 2026 06:39
@muhammad-a-dev

Copy link
Copy Markdown
Author

Thanks @StanFromIreland — I've moved the examples into the existing "Changes that require NEWS entries" section in pull-request-lifecycle.rst and removed the separate page, so they sit with the current NEWS guidance instead of duplicating it. I'll sign the CLA next.

@muhammad-a-dev
muhammad-a-dev marked this pull request as ready for review September 17, 2026 09:04
@hugovk
hugovk marked this pull request as draft September 17, 2026 09:11
@muhammad-a-dev

Copy link
Copy Markdown
Author

CLA is signed now — bot shows all commit authors covered.

@muhammad-a-dev
muhammad-a-dev marked this pull request as ready for review September 17, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add more examples to the NEWS/What's New docs

2 participants