Skip to content

Github errors parsing changelog in CHANGELOG.md and release 2.12.0 #1272

Open
@yedayak

Description

@yedayak

Describe the bug

First mentioned in #1179
When looking at release 2.12.0, there are errors rendering a few of the lines:

 Extra open brace or missing close brace 

image

The issue is that github interprets anything between two dollar signs ($) as a LaTeX expression, parsed with MathJax. The 4 lines that create the error all have a single opening brace between two dollar signs, for example:

CHANGELOG.md:* **dict:** work around bash-4.3 ${v+"$@"} with custom IFS ([cc21298](https://github.com/scop/bash-completion/commit/cc212983a2b2523e5b62e9735c6dff5f011bb80a))

Just ${$ (unquoted) is enough to trigger this.
I will create a PR to quote these in the changelog. I don't know if editing the release itself will change the date on it?
Do you think it's worth creating some kind of lint to catch stuff like that or filing an issue with release please?

To reproduce

Look at the bug fixes in CHANGELOG.md in the 2.12.0 section

Expected behavior

No errors when rendering

Versions (please complete the following information)

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions