Skip to content

Add concrete NEWS entry examples #1906

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

Open
muhammad-a-dev wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add concrete NEWS entry examples #1906

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
55a7056
Add NEWS entry examples page
muhammad-a-dev Sep 17, 2026
830fdec
Link NEWS entry examples from the getting-started toctree
muhammad-a-dev Sep 17, 2026
62a917a
Remove news-entry-examples from Getting started toctree.
muhammad-a-dev Sep 17, 2026
ba490c1
Inline NEWS entry examples under existing guidance.
muhammad-a-dev Sep 17, 2026
267aac2
Remove sibling NEWS entry examples page.
muhammad-a-dev Sep 17, 2026
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
19 changes: 19 additions & 0 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,25 @@ For the last two, note the following:
change and the original** ``NEWS`` **entry remains valid**, then no additional
entry is needed.

Examples
~~~~~~~~

The following examples typically **do** need a ``NEWS`` entry:

* a new function, method, class, or module
* a new HOWTO in the documentation
* the removal of a deprecated feature

The following examples typically **do not** need a ``NEWS`` entry:

* a new feature was included in Python 3.13 alpha 1, but got removed in
3.13 beta 2, before the final release of 3.13
* a typo fix in the documentation or in a docstring
* the addition of a new test method
* the removal of a private and internal API
* code refactoring of a module with no user-visible effects
Comment on lines +247 to +252

@StanFromIreland StanFromIreland Sep 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Essentially all of these are covered in the above section (albeit slightly tersely), so I don't think we need to duplicate them.

With that, I'm not sure there is much need for the above, either (since we tell you what not to add one for, it's implied you should add one in other cases). Ezio's comments pre-date some changes to this section, so I'm not sure if they have been addressed. WDYT @ezio-melotti ?



Changes that require "What's New in Python" entries
---------------------------------------------------

Expand Down
Loading