chovy-3012 opened a new pull request, #12675:
URL: https://github.com/apache/seatunnel/pull/12675

   ### Purpose of this pull request
   
   Fixes #12674. The Mqtt `field_delimiter` description contains an unescaped 
`|` inside a markdown table cell, which truncates the description at the pipe 
when rendered (the `|` and `\t` examples are lost). This PR escapes the pipe as 
`\|` in en/zh sink docs and aligns the en/zh source docs (adds missing 
per-option subsections to zh, adds a tip block and TLS/SSL & text-delimited 
examples to en, moves `field_delimiter` examples inline into the table 
description).
   
   ### Does this PR introduce _any_ user-facing change?
   
   Yes — documentation fix only. The Mqtt `field_delimiter` description now 
renders completely instead of being truncated at the `|`. Connector document 
changes follow the specifications in #4544.
   
   ### How was this patch tested?
   
   No code tests (docs-only). Verified by rendering the updated tables with 
`marked` and `markdown-it`: the `\|` escape renders as a literal pipe inside a 
`<code>` span and the description is no longer truncated. En/zh source docs 
were checked to have matching section structure.
   
   ### Check list
   
   * [ ] If any new Jar binary package adding in your PR, please add License 
Notice according [New License 
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md)
 — N/A, no new jars
   * [x] If necessary, please update the documentation to describe the new 
feature. — yes, this PR updates Mqtt en/zh docs
   * [ ] If necessary, please update `incompatible-changes.md` to describe the 
incompatibility caused by this PR. — N/A, no incompatible changes
   * [ ] If you are contributing the connector code, please check that the 
following files are updated: — N/A, docs-only, no connector code
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to