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

Rework the docs for NEWS/What's New entries #1238

Merged

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Dec 6, 2023

  • Add subsubsections instead of keeping all the text in a single large subsection
  • Add some text about how to word NEWS entries
  • Mention that test and strictly internal changes seldom require NEWS entries

(Some minor wording changes might have snuck in, but largely, I kept the existing text.)


📚 Documentation preview 📚: https://cpython-devguide--1238.org.readthedocs.build/core-developers/committing/#updating-news-and-what-s-new-in-python

@erlend-aasland

This comment was marked as resolved.

@erlend-aasland

This comment was marked as resolved.

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is great! I agree that https://github.com/python/devguide/pull/1238/files#r1417449912 would improve things further.

Also: should we think about moving this information to a different file altogether? This information isn't just relevant to core developers; it's relevant to any contributors.

It's possible (and easy) for core developers to add NEWS entries to other contributors' PRs, but few core devs do so; the de-facto expectation is that contributors should write their own NEWS entries

@erlend-aasland
Copy link
Contributor Author

Also: should we think about moving this information to a different file altogether? This information isn't just relevant to core developers; it's relevant to any contributors.

That's a good idea. Let's do it in a follow-up PR.

erlend-aasland and others added 2 commits December 6, 2023 21:45
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@erlend-aasland
Copy link
Contributor Author

I'm very pleased with how this turned out. Thanks for your input, everyone! I'll land tomorrow.

@erlend-aasland erlend-aasland merged commit 44e62d5 into python:main Dec 7, 2023
@erlend-aasland erlend-aasland deleted the issue-935/news-entry-content branch December 7, 2023 14:03
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Dec 7, 2023

@AlexWaygood and @ezio-melotti, I've created follow-up issues for your suggestions regarding further improvements. Let me know if I forgot something.

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

Successfully merging this pull request may close these issues.

More clearly document what the contents of NEWS entries should be
5 participants