Skip to content

Keep sections in importance order#75

Merged
hugovk merged 1 commit intopython:mainfrom
hugovk:fix-section-order
Mar 17, 2026
Merged

Keep sections in importance order#75
hugovk merged 1 commit intopython:mainfrom
hugovk:fix-section-order

Conversation

@hugovk
Copy link
Member

@hugovk hugovk commented Mar 11, 2026

Recent changelog entries at https://docs.python.org/3.15/whatsnew/changelog.html have their sections in this order:

  • macOS
  • Windows
  • Tools/Demos
  • Tests
  • Security
  • Library
  • IDLE
  • Documentation
  • Core and Builtins
  • C API
  • Build

Which is case-sensitive reverse alphabetical.

Prior to 3.14.0a1, they were in the order of the blurb template, which is sort of most important first:

  • Security
  • Core and Builtins
  • Library
  • Documentation
  • Tests
  • Build
  • Windows
  • macOS
  • IDLE
  • Tools/Demos
  • C API

This bug was introduced by the use of sets and a final global reverse sort in python/core-workflow#499.

Fix by

Thanks to @mcepl for reporting this at https://discuss.python.org/t/python-3-15-0-alpha-7/106475/2.

Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

LGTM

seen_dirs.add(dir_name)
wildcard = os.path.join(base, dir_name, '*.rst')
for entry in glob.glob(wildcard):
if not entry.endswith('/README.rst'):
Copy link
Member

Choose a reason for hiding this comment

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

Hmm won't this fail on Windows? But this is a prexisting issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I saw that too but kept this PR focused. And this function is only called by the release process, which only supports Linux and macOS, which is enough for all the RMs.

@hugovk hugovk merged commit f8fc381 into python:main Mar 17, 2026
11 checks passed
@hugovk hugovk deleted the fix-section-order branch March 17, 2026 07:44
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.

2 participants