-
Notifications
You must be signed in to change notification settings - Fork 384
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
Github errors parsing changelog in CHANGELOG.md and release 2.12.0 #1272
Comments
I don't think it will. I'm not familiar with it, but
We may need to add a rule for the commit message so that We might file an issue in the upstream |
Describe the bug
First mentioned in #1179
When looking at release 2.12.0, there are errors rendering a few of the lines:
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: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
The text was updated successfully, but these errors were encountered: