functions-and-operators: remove MySQL Reference Manual links #21821
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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
missing-translation-status
Summary of ChangesHello @dveeden, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the TiDB documentation by streamlining the user experience for functions and operators. It systematically removes direct links to the MySQL Reference Manual for features that are comprehensively documented within TiDB's own pages. This change aims to keep users within the TiDB documentation ecosystem, providing a more cohesive and self-contained information source, while still acknowledging MySQL compatibility where necessary. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
With this PR: And with |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes external links to the MySQL Reference Manual from function documentation, which is a good cleanup. My review focuses on ensuring the formatting of the updated headings is consistent with the documentation style guide. I've found several instances in the JSON function documents where function names in headings are missing backticks and have provided suggestions to fix them.
| The functions listed on this page are part of the [aggregate functions](/functions-and-operators/aggregate-group-by-functions.md) that TiDB supports, but are specific to working with JSON. | ||
|
|
||
| ## [JSON_ARRAYAGG()](https://dev.mysql.com/doc/refman/8.0/en/aggregate-functions.html#function_json-arrayagg) | ||
| ## JSON_ARRAYAGG() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_ARRAYAGG() | |
| ## `JSON_ARRAYAGG()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_OBJECTAGG()](https://dev.mysql.com/doc/refman/8.0/en/aggregate-functions.html#function_json-objectagg) | ||
| ## JSON_OBJECTAGG() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_OBJECTAGG() | |
| ## `JSON_OBJECTAGG()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| This document describes JSON functions that create JSON values. | ||
|
|
||
| ## [JSON_ARRAY()](https://dev.mysql.com/doc/refman/8.0/en/json-creation-functions.html#function_json-array) | ||
| ## JSON_ARRAY() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_ARRAY() | |
| ## `JSON_ARRAY()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_OBJECT()](https://dev.mysql.com/doc/refman/8.0/en/json-creation-functions.html#function_json-object) | ||
| ## JSON_OBJECT() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_OBJECT() | |
| ## `JSON_OBJECT()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_QUOTE()](https://dev.mysql.com/doc/refman/8.0/en/json-creation-functions.html#function_json-quote) | ||
| ## JSON_QUOTE() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_QUOTE() | |
| ## `JSON_QUOTE()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_OVERLAPS()](https://dev.mysql.com/doc/refman/8.0/en/json-search-functions.html#function_json-overlaps) | ||
| ## JSON_OVERLAPS() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_OVERLAPS() | |
| ## `JSON_OVERLAPS()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| This document describes JSON utility functions. | ||
|
|
||
| ## [JSON_PRETTY()](https://dev.mysql.com/doc/refman/8.0/en/json-utility-functions.html#function_json-pretty) | ||
| ## JSON_PRETTY() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_PRETTY() | |
| ## `JSON_PRETTY()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_STORAGE_FREE()](https://dev.mysql.com/doc/refman/8.0/en/json-utility-functions.html#function_json-storage-free) | ||
| ## JSON_STORAGE_FREE() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_STORAGE_FREE() | |
| ## `JSON_STORAGE_FREE()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| ``` | ||
|
|
||
| ## [JSON_STORAGE_SIZE()](https://dev.mysql.com/doc/refman/8.0/en/json-utility-functions.html#function_json-storage-size) | ||
| ## JSON_STORAGE_SIZE() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_STORAGE_SIZE() | |
| ## `JSON_STORAGE_SIZE()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
| > Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | ||
| ## [JSON_SCHEMA_VALID()](https://dev.mysql.com/doc/refman/8.0/en/json-validation-functions.html#function_json-schema-valid) | ||
| ## JSON_SCHEMA_VALID() |
There was a problem hiding this comment.
To adhere to the style guide, function and operator names in headings should be enclosed in backticks for proper code formatting.1
| ## JSON_SCHEMA_VALID() | |
| ## `JSON_SCHEMA_VALID()` |
Style Guide References
Footnotes
-
The style guide specifies that code snippets, command names, options, and paths should be enclosed in backticks. ↩
First-time contributors' checklist
What is changed, added or deleted? (Required)
TiDB supports most of the user-level [locking functions](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html) available in MySQL 8.0.This was done with
sed -E -i -e 's/(^#* )\[(.*)\].*$/\1\2/' path/to/file.mdWhich TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?