Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
erlend-aasland opened this issue Dec 7, 2023 · 0 comments
Open

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

erlend-aasland opened this issue Dec 7, 2023 · 0 comments

Comments

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Dec 7, 2023

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant