tool
/
starrocks
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Doc] Format setting names in README as inline code (#62835) 

Signed-off-by: Dan Roscigno <dan@roscigno.com>
This commit is contained in:
Dan Roscigno 2025-09-08 21:19:33 -04:00 committed by GitHub
parent 4f11d84fcf
commit c6e908cacb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@ -33,11 +33,11 @@ Before contributing, please read this article carefully to quickly understand th
Long lists of settings like this do not index well in search, and the reader will not find the information even when they type in the exact name of a setting:
```markdown
- setting_name_foo
- `setting_name_foo`
Details for foo
- setting_name_bar
- `setting_name_bar`
Details for bar
...
```
@ -45,11 +45,11 @@ Before contributing, please read this article carefully to quickly understand th
Instead, use a section heading (e.g., `###`) for the setting name and remove the indent for the text:
```markdown
### setting_name_foo
### `setting_name_foo`
Details for foo
### setting_name_bar
### `setting_name_bar`
Details for bar
...
```