Skip to content
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

sql-statements: improve alter index docs #4453

Merged
merged 3 commits into from
Sep 10, 2020

Conversation

TomShawn
Copy link
Contributor

@TomShawn TomShawn commented Sep 8, 2020

What is changed, added or deleted? (Required)

This only applies to master, which features invisible indexes.

It improves the consistency of the docs for ALTER INDEX to follow the common format (including ## MySQL compatibility). There is some duplication in the page where it has examples, and then a section for invisible indexes with examples. Since the main use case for this statement is for invisible indexes, I merged the two together. The ## syntax section is also somewhat redundant with both the synposis and examples sections. So I've removed it.

The CREATE INDEX docs are also updated to remove a broken link, pointing to ALTER INDEX for invisible index docs. Really invisible indexes should have its own documentation page, with these pages just being for statement reference - but that's for a different task. The text also said that it was a "new feature introduced in MySQL 8.0" -- I think this text can be confusing to a casual reader, because it could imply that TiDB is somehow code-related to MySQL 8.0, which it is not.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Have version specific changes
  • Might cause conflicts

@TomShawn TomShawn added translation/from-docs This PR is translated from a PR in pingcap/docs. size/small Changes of a small size. status/PTAL This PR is ready for reviewing. v5.0 This PR/issue applies to TiDB v5.0 labels Sep 8, 2020
Copy link
Contributor

@ran-huang ran-huang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Sep 8, 2020
Co-authored-by: Ran <huangran@pingcap.com>
@ti-srebot
Copy link
Contributor

@ran-huang, @bb7133, @AilinKid, PTAL.

1 similar comment
@ti-srebot
Copy link
Contributor

@ran-huang, @bb7133, @AilinKid, PTAL.

Copy link
Member

@bb7133 bb7133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-srebot
Copy link
Contributor

@bb7133,Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments.See the corresponding SIG page for more information. Related SIG: docs(slack).

@TomShawn TomShawn merged commit 3903310 into pingcap:master Sep 10, 2020
@TomShawn TomShawn deleted the alter-index-refines branch September 10, 2020 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/small Changes of a small size. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. translation/from-docs This PR is translated from a PR in pingcap/docs. v5.0 This PR/issue applies to TiDB v5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants