Add concrete NEWS entry examples - #1906
muhammad-a-dev wants to merge 5 commits into
Conversation
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
|
|
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. |
|
Thanks @StanFromIreland — I've moved the examples into the existing "Changes that require NEWS entries" section in |
|
CLA is signed now — bot shows all commit authors covered. |
| * 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 |
There was a problem hiding this comment.
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 ?
2 participants
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):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.