Escape chars to fix HTML rendering errors #3028
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kddnewton
requested changes
Sep 3, 2024
There was a problem hiding this comment.
This is currently failing doxygen. (https://github.com/ruby/prism/actions/runs/10638854883/job/29495664260?pr=3028#step:8:155).
I think in general I would prefer that the templates themselves perform this kind of escaping as opposed to the YAML file itself. This is meant to be read by anything, so it's not really a concerns of the YAML file whether or not the C docs render correctly.
9a646dc to
60857cf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All the special characters in the tokens' docs result in garbled HTML:
Fixed: