Suggestions for Optimizing the Official Documentation's Explain Section

Translated
1

Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.

Original topic: 官档explain部分建议优化

| username: ShawnYan

The documentation is unclear or incomplete. Please submit according to the template below:

  • Issue category: Content too brief, unclear description with ambiguities, incomplete steps
  • Page where it appears: Link + screenshot
  • Issue:

In the official documentation, the explain section,

The description for FORMAT is unclear. It is recommended to supplement and improve it, preferably presented in a list format, clearly indicating what is supported and what is not.
For example, the official documentation does not have a relevant description for format=true_card_cost.

2
| username: Billmay表妹 | Original post link

Feedback provided~ Waiting for a response from the team~

3
| username: shichun-0415 | Original post link

Sorry for the wait. The PR with the format description in Chinese is available now: revise explain format by list by Yisaer · Pull Request #11185 · pingcap/docs-cn · GitHub. Please feel free to review it. The English version can be submitted once the Chinese version is merged.

4
| username: h5n1 | Original post link

Could the operator info be separated and placed below the execution plan? Some of them are too long and really affect readability.

5
| username: shichun-0415 | Original post link

Request received, we will evaluate it.

6
| username: system | Original post link

This topic was automatically closed 1 minute after the last reply. No new replies are allowed.