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

RELEASE_NOTES include extra items #2422

Closed
edwardhartnett opened this issue Jun 23, 2022 · 2 comments · Fixed by #2423
Closed

RELEASE_NOTES include extra items #2422

edwardhartnett opened this issue Jun 23, 2022 · 2 comments · Fixed by #2423

Comments

@edwardhartnett
Copy link
Contributor

There is a bunch of extra text in the RELEASE_NOTES.md file that was apparently inserted by mistake. In addition to the usual bullet list, there is a list of all commit message since 4.3.1.

This is what is causing #2421 to fail. Between the time that @DennisHeimbigner took his branch and submitted his PR, the automatic checking of doxygen documentation in the CI had been turned on in #2377.

In the RELEASE_NOTES.md file, as with all doxygen files, all uses of the @ character must be escaped. For example, here's some correct usage from the file:

* [BugFix][Enhancement] Various and sundry bugfixes and performance enhancements, thanks to \@edhartnett, \@gsjaardema, \@t-b, \@wkliao, and all of our other contributors.

Note that the @ in all cases is preceded with a backslash . So it needs to be \@t-b not just @t-b

There are a lot of ampersands in the extra material in RELEASE_NOTES.md, and they are generating doxygen warnings, which are being treated (correctly) as errors in the CI.

@edwardhartnett
Copy link
Contributor Author

Also looking at the release notes on-line I see the bullet list becomes a little unhinged after the forth bullet point... Not sure what is happening there...

@edwardhartnett
Copy link
Contributor Author

edwardhartnett commented Jun 23, 2022

OK it was a stray quote that didn't have a matching quote. That caused the bullet list to go bonkers:

image

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 a pull request may close this issue.

1 participant