Skip to content

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

Description

@erlend-aasland

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 ✔️ good/❌ 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 #1238 (comment)

Activity

  1. Ssuubi-Grace commented on Oct 10, 2024

    @Ssuubi-Grace

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

  2. hugovk commented on Oct 10, 2024

    @hugovk
    Member

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

  3. StanFromIreland commented on Sep 13, 2025

    @StanFromIreland
    Member

    Please note that #674 is a prerequisite to avoid introducing conflicts.

  4. added 3 commits that reference this issue on Sep 17, 2026
    3f4b9e7
    11d85a4
    55a7056
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions