Skip to content

Commit

Permalink
Stop reversing changelog entries
Browse files Browse the repository at this point in the history
This makes entries show up in the same order in the generated docs as in changelog.txt

The only other significant difference this causes is that when notes from multiple prereleases are combined into one stable release, changes from the newer version will show up first now (i.e. in the same order as reading the changelog from the top down), but this has minimal impact.
  • Loading branch information
lethosor committed Dec 24, 2020
1 parent c6aac0d commit debeac1
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/sphinx_extensions/dfhack/changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,6 @@ def parse_changelog():
def consolidate_changelog(all_entries):
for sections in all_entries.values():
for section, entries in sections.items():
# sort() is stable, so reverse entries so that older entries for the
# same feature are on top
entries.reverse()
entries.sort(key=lambda entry: entry.sort_key)
new_entries = []
for feature, group in itertools.groupby(entries,
Expand Down

0 comments on commit debeac1

Please sign in to comment.