-
Notifications
You must be signed in to change notification settings - Fork 708
functions-and-operators: remove MySQL Reference Manual links #21821
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
functions-and-operators/json-functions/json-functions-aggregate.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-aggregate.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-create.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-create.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-create.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-search.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-utility.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-utility.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-utility.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-validate.md
Outdated
Show resolved
Hide resolved
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@dveeden, I've added some MySQL doc links to the Jason function docs. PTAL. Thanks. |
In general this is ok. But maybe we should consider to put MySQL compatibility info in a separate section in the end of the document instead? The main goal of these documents should be to describe the functionality of TiDB, both for users that migrate from MySQL but also for TiDB users that didn't start with another database. As JSON was implemented after MariaDB was forked off, there are many differences between MariaDB and MySQL/TiDB. Also note that there is now an official standard: ISO/IEC 19075-6:2021. So in the future we may want to list MySQL, MariaDB and ISO standard compatibility. For now there is no need to change anything, please keep this as-is. |
[LGTM Timeline notifier]Timeline:
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
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?