Skip to content

Commit ba490c1

Browse files
Inline NEWS entry examples under existing guidance.
1 parent 62a917a commit ba490c1

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

getting-started/pull-request-lifecycle.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,25 @@ For the last two, note the following:
233233
change and the original** ``NEWS`` **entry remains valid**, then no additional
234234
entry is needed.
235235

236+
Examples
237+
~~~~~~~~
238+
239+
The following examples typically **do** need a ``NEWS`` entry:
240+
241+
* a new function, method, class, or module
242+
* a new HOWTO in the documentation
243+
* the removal of a deprecated feature
244+
245+
The following examples typically **do not** need a ``NEWS`` entry:
246+
247+
* a new feature was included in Python 3.13 alpha 1, but got removed in
248+
3.13 beta 2, before the final release of 3.13
249+
* a typo fix in the documentation or in a docstring
250+
* the addition of a new test method
251+
* the removal of a private and internal API
252+
* code refactoring of a module with no user-visible effects
253+
254+
236255
Changes that require "What's New in Python" entries
237256
---------------------------------------------------
238257

0 commit comments

Comments
 (0)