Skip to content

Commit 55a7056

Browse files
Add NEWS entry examples page
Closes #1243.
1 parent 8b8b1f2 commit 55a7056

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
NEWS entry examples
2+
===================
3+
4+
This page expands the guidance in :ref:`news-entry` with concrete
5+
examples of when a ``NEWS`` entry is (and is not) required.
6+
7+
Examples that typically **do** need a ``NEWS`` entry
8+
----------------------------------------------------
9+
10+
* a new function, method, class, or module
11+
* a new HOWTO in the documentation
12+
* the removal of a deprecated feature
13+
14+
Examples that typically **do not** need a ``NEWS`` entry
15+
--------------------------------------------------------
16+
17+
* a new feature was included in Python 3.13 alpha 1, but got removed in
18+
3.13 beta 2, before the final release of 3.13
19+
* a typo fix in the documentation or in a docstring
20+
* the addition of a new test method
21+
* the removal of a private and internal API
22+
* code refactoring of a module with no user-visible effects
23+
24+
These examples follow the existing rules under :ref:`news-entry`:
25+
documentation-only changes, test-only changes, and strictly internal
26+
changes with no user-visible effects generally skip a ``NEWS`` entry.

0 commit comments

Comments
 (0)