[SPARK-28806] [DOCS] [FOLLOW-UP] Remove unneeded HTML from the MD file #28414
Conversation
This file contains hidden or 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
gatorsmile
commented
Apr 30, 2020
| <b>Note:</b> | ||
| Keywords <code>IN</code> and <code>FROM</code> are interchangeable. | ||
| </dd> | ||
| </dl> |
Member
Author
There was a problem hiding this comment.
Let us avoid using HTML if possible.
gatorsmile
commented
Apr 30, 2020
|
|
||
| ### Examples | ||
|
|
||
| {% highlight sql %} |
Member
Author
There was a problem hiding this comment.
We can directly use ```sql
gatorsmile
commented
Apr 30, 2020
|
|
||
| ### Related Statements | ||
|
|
||
| * [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html) |
Member
Author
|
cc @huaxingao Could you help fix all the other pages like this example? |
gatorsmile
commented
Apr 30, 2020
| * **database** | ||
|
|
||
| Specifies an optional database name. The table is resolved from this database when it | ||
| is specified. Please note that when this parameter is specified then table |
Member
Author
There was a problem hiding this comment.
Nit: removed Please note that
Member
Author
|
Also cc @dilipbiswal |
|
Test build #122097 has finished for PR 28414 at commit
|
|
Test build #122099 has finished for PR 28414 at commit
|
Contributor
|
LGTM |
srowen
approved these changes
Apr 30, 2020
gatorsmile
added a commit
that referenced
this pull request
Apr 30, 2020
### What changes were proposed in this pull request? This PR is to clean up the markdown file in SHOW COLUMNS page. - remove the unneeded embedded inline HTML markup by using the basic markdown syntax. - use the ``` sql for highlighting the SQL syntax. ### Why are the changes needed? Make the doc cleaner and easily editable by MD editors. ### Does this PR introduce _any_ user-facing change? NO ### How was this patch tested? **Before**  **After**  Closes #28414 from gatorsmile/cleanupShowColumns. Lead-authored-by: Xiao Li <[email protected]> Co-authored-by: gatorsmile <[email protected]> Signed-off-by: gatorsmile <[email protected]> (cherry picked from commit b5ecc41) Signed-off-by: gatorsmile <[email protected]>
Member
Author
|
Thanks! Merged to master/3.0 |
This was referenced May 1, 2020
srowen
pushed a commit
that referenced
this pull request
May 10, 2020
### What changes were proposed in this pull request? Remove the unneeded embedded inline HTML markup by using the basic markdown syntax. Please see #28414 ### Why are the changes needed? Make the doc cleaner and easily editable by MD editors. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Manually build and check Closes #28451 from huaxingao/html_cleanup. Authored-by: Huaxin Gao <[email protected]> Signed-off-by: Sean Owen <[email protected]>
srowen
pushed a commit
that referenced
this pull request
May 10, 2020
### What changes were proposed in this pull request? Remove the unneeded embedded inline HTML markup by using the basic markdown syntax. Please see #28414 ### Why are the changes needed? Make the doc cleaner and easily editable by MD editors. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Manually build and check Closes #28451 from huaxingao/html_cleanup. Authored-by: Huaxin Gao <[email protected]> Signed-off-by: Sean Owen <[email protected]> (cherry picked from commit a75dc80) Signed-off-by: Sean Owen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 changes were proposed in this pull request?
This PR is to clean up the markdown file in SHOW COLUMNS page.
Why are the changes needed?
Make the doc cleaner and easily editable by MD editors.
Does this PR introduce any user-facing change?
NO
How was this patch tested?
Before
After