-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[improve][doc] Use Text Blocks to improve JSON text #17521
Conversation
Could you use |
OK. |
@nodece PTAL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
/pulsarbot run-failure-checks |
Overall job is optional, so you don't need to rerun the failure job. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool! Glad to see we gradually use new features beyond JDK11.
Out of the topic, we may be careful about using some new features like var
- they will cause significant style inconsistency.
This is a good start, but we may need to note that this change does not benefit the cherry-pick operations, the old version doesn't support this syntax. |
@momo-jun PTAL |
I just notice this is for example shown on the doc. It can be a concern that leading whitespace may cause margin error. But fortunately Java text block detect margin by the close |
Motivation
The JSON text has a lot of escape characters, we can use Text Blocks to improve it.
Modifications
Use Text Blocks to improve JSON text
Need to update docs?
doc-required
(Your PR needs to update docs and you will update later)
doc-not-needed
(Please explain why)
doc
(Your PR contains doc changes)
doc-complete
(Docs have been already added)