-
Notifications
You must be signed in to change notification settings - Fork 690
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 #3586
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kolbe
approved these changes
Aug 10, 2020
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.
LGTM
TomShawn
approved these changes
Aug 14, 2020
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.
Rest LGTM
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
size/medium
Changes of a medium size.
status/LGT1
Indicates that a PR has LGTM 1.
status/PTAL
This PR is ready for reviewing.
translation/done
This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
v5.0
This PR/issue applies to TiDB v5.0.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 toALTER 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)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?