Skip to content

[MINOR][DOCS] replace `-formatted code with <code> tags inside configuration.md tables#45731

Closed
vadim wants to merge 1 commit intoapache:masterfrom
vadim:patch-1
Closed

[MINOR][DOCS] replace `-formatted code with <code> tags inside configuration.md tables#45731
vadim wants to merge 1 commit intoapache:masterfrom
vadim:patch-1

Conversation

@vadim
Copy link
Contributor

@vadim vadim commented Mar 26, 2024

What changes were proposed in this pull request?

Inside HTML tables in the configuration webpage configuration.md, some markdown-formatted code were not rendering correctly, with ` visible.

replace `foo` with <code>foo</code>.

Why are the changes needed?

For rendering the code block properly.

Does this PR introduce any user-facing change?

Yes, it fixes the user-facing documentation.

How was this patch tested?

Manually tested at #45731 (comment)

Was this patch authored or co-authored using generative AI tooling?

No.

Many code snippets were not rendering correctly, with ` visible. Changed to <code>foo</code>.
@github-actions github-actions bot added the DOCS label Mar 26, 2024
@HyukjinKwon HyukjinKwon changed the title Update <code>tags inside configuration.md tables [MINOR][DOCS] Update <code>tags inside configuration.md tables Mar 27, 2024
@HyukjinKwon
Copy link
Member

Mind showing screenshot before/after?

@dongjoon-hyun
Copy link
Member

+1 for the above comment.

@vadim
Copy link
Contributor Author

vadim commented Apr 3, 2024

first example:
Screenshot 2024-04-02 at 21 14 14

second example:
Screenshot 2024-04-02 at 21 14 18

@yaooqinn
Copy link
Member

yaooqinn commented Apr 3, 2024

@vadim can you revise the PR description?

@vadim vadim changed the title [MINOR][DOCS] Update <code>tags inside configuration.md tables [MINOR][DOCS] replace `-formatted code with <code> tags inside configuration.md tables Apr 3, 2024
@HyukjinKwon
Copy link
Member

Merged to master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments