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

Scripts: Fix indentation of changelog items #4295

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

neobrain
Copy link
Member

Looking e.g. over the 2405 release notes, I noticed categories and descriptions are placed on separate lines:

  • Allocator
  • Fixes compiling on Fedora 40 (7b88b0f)
  • AllocatorHooks
  • Mark JIT code memory as EC code on ARM64EC (bb24e14)
  • AppConfig
  • Disable libGL forwarding for steamwebhelper (02ebb6e)

Instead, the descriptions were meant to be placed in sublists (since there might be multiple per category):

  • Allocator
    • Fixes compiling on Fedora 40 (7b88b0f)
  • AllocatorHooks
    • Mark JIT code memory as EC code on ARM64EC (bb24e14)
  • AppConfig
    • Disable libGL forwarding for steamwebhelper (02ebb6e)

The source of the issue is that GitHub's markdown parser requires at least 2 spaces to open a new level of indentation, but we only used 1.

GitHub's markdown parser requires at least 2 spaces to open a new level
of indentation.
@neobrain neobrain merged commit 276e9ad into FEX-Emu:main Jan 22, 2025
12 checks passed
@neobrain neobrain deleted the fix_changelog_script branch January 22, 2025 18:40
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