You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@paimon.apache.org by "thswlsqls (via GitHub)" <gi...@apache.org> on 2026/07/11 05:57:43 UTC
[PR] [docs] Escape ampersand (&) in config doc generator's escapeCharacters [paimon]
thswlsqls opened a new pull request, #8552:
URL: https://github.com/apache/paimon/pull/8552
### Purpose
fix #8551
- `Utils.escapeCharacters` escaped `<` and `>` but not `&`, so an `&` in a config option key/default/type/enum column was left unescaped in the generated HTML.
- Add a `&` -> `&` replacement first (before `<`/`>`) so the `&` in the produced `<`/`>` is not double-escaped.
- Matches the sibling `HtmlFormatter.escapeCharacters` (paimon-api), which renders the Description column of the same table and already escapes `&`, `<`, `>`.
### Tests
- Added `UtilsTest` covering `&` 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 `&`), so `ConfigOptionsDocsCompletenessITCase` is unaffected and passed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@paimon.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs] Escape ampersand (&) in config doc generator's escapeCharacters [paimon]
Posted by "JingsongLi (via GitHub)" <gi...@apache.org>.
JingsongLi commented on PR #8552:
URL: https://github.com/apache/paimon/pull/8552#issuecomment-4953866729
+1
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@paimon.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs] Escape ampersand (&) in config doc generator's escapeCharacters [paimon]
Posted by "JingsongLi (via GitHub)" <gi...@apache.org>.
JingsongLi merged PR #8552:
URL: https://github.com/apache/paimon/pull/8552
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@paimon.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org