[docs] Escape ampersand (&) in config doc generator's escapeCharacters#8552
Open
thswlsqls wants to merge 1 commit into
Open
[docs] Escape ampersand (&) in config doc generator's escapeCharacters#8552thswlsqls wants to merge 1 commit into
thswlsqls wants to merge 1 commit into
Conversation
Generated-by: Claude Code
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
1 participant
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.
Purpose
fix #8551
Utils.escapeCharactersescaped<and>but not&, so an&in a config option key/default/type/enum column was left unescaped in the generated HTML.&->&replacement first (before</>) so the&in the produced</>is not double-escaped.HtmlFormatter.escapeCharacters(paimon-api), which renders the Description column of the same table and already escapes&,<,>.Tests
UtilsTestcovering&escaping, order correctness (<a&b>-><a&b>),<wbr>preservation, and unchanged</>escaping.mvn -pl paimon-docs -DfailIfNoTests=false clean install— 13 unit tests passed. Generated-docs diff is 0 (no existing option contains&), soConfigOptionsDocsCompletenessITCaseis unaffected and passed.