Fix hover markdown escaping so links are usable#1159
Merged
datho7561 merged 2 commits intoredhat-developer:mainfrom Dec 18, 2025
Merged
Fix hover markdown escaping so links are usable#1159datho7561 merged 2 commits intoredhat-developer:mainfrom
datho7561 merged 2 commits intoredhat-developer:mainfrom
Conversation
Signed-off-by: Morgan Chang <shin19991207@gmail.com>
datho7561
approved these changes
Dec 18, 2025
Contributor
datho7561
left a comment
There was a problem hiding this comment.
Looks good and addresses the bug. It's pretty safe to not escape these special characters, I think they're used exclusively for links and ordered lists. Thanks, Morgan!
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
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.
What does this PR do?
Hover content is rendered as Markdown, so plain-text schema descriptions must be escaped for Markdown. The current escaping escapes punctuation like
.and(), which can, for example, change a URL at the end of a sentence intohttps://hub\.docker\.com/\.. When the text is being auto-linkified by the hover renderer, it then include the backslash in the auto-detected link, making it end with \ and become unusable (for example,https://hub.docker.com/\).This is fixed by updating YamlHover.toMarkdown() to stop escaping punctuation commonly used with URLs i.e.
.().Note: Best practice is for schemas to wrap URLs in
<...>(for example,<https://example.com>), so the renderer treats them as explicit autolinks and they reliably stay usable.What issues does this PR fix or reference?
Is it tested? How?
Automated test:
()parentheses and.dots remain literal even without escaping in descriptions.Manual test:
.github/workflows/daily.yamlactions/checkout@v4. Links in there should be usable.