You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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...
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.
The text was updated successfully, but these errors were encountered: