docs: use a shorter SHOW VARIABLES example#23176
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @doc-claw-bot. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
There was a problem hiding this comment.
Code Review
This pull request updates the sql-statement-show-variables.md documentation by truncating the long example output of SHOW GLOBAL VARIABLES LIKE 'tidb%' to a shorter, representative list, and updating the introductory text. The reviewer suggested a minor phrasing improvement to change "part of the TiDB-specific global variables" to "some of the TiDB-specific global variables" to enhance readability and use more idiomatic technical English.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| ## Examples | ||
|
|
||
| List all TiDB specific variables. For detailed description, refer to [System Variables](/system-variables.md). | ||
| The following example shows part of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md). |
There was a problem hiding this comment.
To improve readability and use more idiomatic technical English, consider changing "part of the TiDB-specific global variables" to "some of the TiDB-specific global variables".
| The following example shows part of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md). | |
| The following example shows some of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md). |
References
- Clarity, simplicity, completeness, and readability are key aspects of documentation review. (link)
What is changed, added or deleted? (Required)
SHOW GLOBAL VARIABLES LIKE 'tidb%'example with a shorter verifiedSHOW GLOBAL VARIABLES LIKE 'tidb_stmt_summary%'exampletidb_wait_split_region_finishrow in the example outputWhich TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?