fix: escape curly brakets for markdown #81
Merged
Conversation
This file contains 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
Signed-off-by: Rémi BUISSON <remi-buisson@orange.fr>
thbkrkr
approved these changes
Jul 22, 2024
thbkrkr
reviewed
Jul 22, 2024
| @@ -145,6 +145,10 @@ func (m *MarkdownRenderer) RenderFieldDoc(text string) string { | |||
| // so that including | in a comment does not result in wonky tables. | |||
| out := strings.ReplaceAll(text, "|", "\\|") | |||
|
|
|||
| // Escape the curly bracket character. | |||
| out = strings.ReplaceAll(out, "{", "\\{") | |||
| out = strings.ReplaceAll(out, "}", "\\}") | |||
There was a problem hiding this comment.
We do the same thing in RenderDefault but I think it's okay to duplicate. We will see in the future if we share some of the chars to be escaped between the two functions.
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.
markdownRenderFieldDocshould espace{and}.