devguide icon indicating copy to clipboard operation
devguide copied to clipboard

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

Open erlend-aasland opened this issue 2 years ago • 3 comments

I think having a concise list is good, but if we want to elaborate more and clarify we could also provide some examples. An example for this is "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.".

If we add examples, we could follow the :heavy_check_mark: good/:x: bad format and do one or two lists with examples like:

✅ the following examples need a NEWS entry:
* a new function, method, class, module
* a new HOWTO in the documentation
* the removal of a deprecated feature
* ...

❌ the following examples *don't* 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

Originally posted by @ezio-melotti in https://github.com/python/devguide/pull/1238#discussion_r1417763167

erlend-aasland avatar Dec 07 '23 14:12 erlend-aasland

hey , I would love to work on this issue if you don't mind, thanks.

Ssuubi-Grace avatar Oct 10 '24 13:10 Ssuubi-Grace

That would be great! Would you like to open a pull request with a suggestion?

hugovk avatar Oct 10 '24 13:10 hugovk

Please note that https://github.com/python/devguide/issues/674 is a prerequisite to avoid introducing conflicts.

StanFromIreland avatar Sep 13 '25 09:09 StanFromIreland