[SPARK-31030][SQL][DOCS][FOLLOWUP] Replace HTML Table by Markdown Table #28433

dilipbiswal · 2020-05-01T23:53:19Z

What changes were proposed in this pull request?

This PR is to clean up the markdown file in remaining pages in sql reference. The first one was done by @gatorsmile in 28415

Replace HTML table by MD table
sql-ref-ansi-compliance.md

- **sql-ref-datatypes.md (Scala)**

- **sql-ref-datatypes.md (Java)**

- **sql-ref-datatypes.md (Python)**

- **sql-ref-datatypes.md (R)**

- **sql-ref-datatypes.md (SQL)**

- **sql-ref-syntax-qry-select-tvf.md**

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 using jekyll serve

dilipbiswal · 2020-05-01T23:53:35Z

cc @huaxingao @gatorsmile

SparkQA · 2020-05-02T00:06:50Z

Test build #122182 has finished for PR 28433 at commit 4debc83.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

huaxingao · 2020-05-02T00:56:12Z

docs/sql-ref-ansi-compliance.md

-</tr>
-</table>
+|Property Name|Default|Meaning|Since Version|
+|--- |--- |--- |--- |


Could you align the --- with the column header?

|Property Name|Default|Meaning|Since Version| |-------------|-------|-------|-------------|

@huaxingao Done.

dilipbiswal · 2020-05-02T01:31:31Z

cc @maropu

SparkQA · 2020-05-02T01:45:14Z

Test build #122186 has finished for PR 28433 at commit c419b93.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

maropu · 2020-05-02T02:18:11Z

docs/sql-ref-datatypes.md

 |        3| Infinity|
 +---------+---------+
-{% endhighlight %}
+{% endhighlight %}


What's a difference here?

@maropu Fixed.

maropu · 2020-05-02T02:19:45Z

docs/sql-ref-datetime-pattern.md

 |**''**|single quote|literal|'|
-|**[**|optional section start|||
-|**]**|optional section end|||
+|**[**|optional section start| | |


Need the space between |s? But, no space between |s in line 59?

it would be nicer if we have an extra space between | and |

Yes. Line 59 is needed too

@maropu @gatorsmile OK.

maropu · 2020-05-02T02:24:32Z

Replace HTML table by MD table

All the fixes in docs/sql-ref-* addressed in this PR? I found the tag in sql-ref-null-semantics.md, too;

$ls sql-ref* | xargs grep "<table " .
sql-ref-ansi-compliance.md:<table class="table">
sql-ref-ansi-compliance.md:<table class="table">
sql-ref-datatypes.md:<table class="table">
sql-ref-datatypes.md:<table class="table">
sql-ref-datatypes.md:<table class="table">
sql-ref-datatypes.md:<table class="table">
sql-ref-datatypes.md:<table class="table">
sql-ref-datetime-pattern.md:<table class="table">
sql-ref-null-semantics.md:<table class="tsclass" border="1">
sql-ref-null-semantics.md:<table class="tsclass" border="1">
sql-ref-null-semantics.md:<table class="tsclass" border="1">
sql-ref-null-semantics.md:<table class="tsclass" border="1">
sql-ref-syntax-qry-select-tvf.md:<table class="table">

dilipbiswal · 2020-05-02T04:32:16Z

@maropu sorry, i missed sql-ref-null-semantics.md. I have added it now.

maropu

Looks okay

SparkQA · 2020-05-02T04:48:53Z

Test build #122193 has finished for PR 28433 at commit 15da96c.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

srowen · 2020-05-02T15:57:34Z

docs/sql-ref-syntax-qry-select-tvf.md

-</table>
+|Function|Argument Type(s)|Description|
+|--------|----------------|-----------|
+|**range** ( end )|Long|Creates a table with a single *LongType* column named *id*, containing<br> rows in a range from 0 to *end* (exclusive) with step value 1.|


Nit, but can we preserve the italics on end for example?

srowen · 2020-05-02T15:57:57Z

docs/sql-ref-ansi-compliance.md

-</table>
+|Property Name|Default|Meaning|Since Version|
+|-------------|-------|-------|-------------|
+|`spark.sql.ansi.enabled`|false|(Experimental) When true, Spark tries to conform to the ANSI SQL specification: <br> 1. Spark will throw a runtime exception if an overflow occurs in any operation on integral/decimal field. <br> 2. Spark will forbid using the reserved keywords of ANSI SQL as identifiers in the SQL parser.|3.0.0|


Also not a big deal, but if you can search/replace <br> for <br/> that's slightly more correct.

For long table cells is there any standard way to wrap the markdown? the markdown source is harder to read now, but not terrible.

@srowen Replaced <br> with <br/> for all the files in this PR. Will look at other files and follow-up if needed. About the wrapping in markdown, i couldn't find any markup syntax to control the cell width. I tried specifying a style for table in the doc and that seems to work ok.

SparkQA · 2020-05-02T22:33:49Z

Test build #122220 has finished for PR 28433 at commit 028746b.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

dilipbiswal · 2020-05-05T02:11:21Z

@maropu @srowen Can this get in now, if there are no other comments ? The reason i ask is @huaxingao has a big PR which is changing a lot of files. If this can get in first then she can rebase and push ?

maropu · 2020-05-05T06:19:44Z

Looks fine and I'll merge this first.

### What changes were proposed in this pull request? This PR is to clean up the markdown file in remaining pages in sql reference. The first one was done by gatorsmile in [28415](#28415) - Replace HTML table by MD table - **sql-ref-ansi-compliance.md** <img width="967" alt="Screen Shot 2020-05-01 at 4 36 35 PM" src="https://user-images.githubusercontent.com/14225158/80848981-1cbca080-8bca-11ea-8a5d-63174b31c800.png"> - **sql-ref-datatypes.md (Scala)** <img width="967" alt="Screen Shot 2020-05-01 at 4 37 30 PM" src="https://user-images.githubusercontent.com/14225158/80849057-6a390d80-8bca-11ea-8866-ab08bab31432.png"> <img width="967" alt="Screen Shot 2020-05-01 at 4 39 18 PM" src="https://user-images.githubusercontent.com/14225158/80849061-6c9b6780-8bca-11ea-834c-eb93d3ab47ae.png"> - **sql-ref-datatypes.md (Java)** <img width="967" alt="Screen Shot 2020-05-01 at 4 41 24 PM" src="https://user-images.githubusercontent.com/14225158/80849138-b3895d00-8bca-11ea-9d3b-555acad2086c.png"> <img width="967" alt="Screen Shot 2020-05-01 at 4 41 39 PM" src="https://user-images.githubusercontent.com/14225158/80849140-b6844d80-8bca-11ea-9ca9-1812b6a76c02.png"> - **sql-ref-datatypes.md (Python)** <img width="967" alt="Screen Shot 2020-05-01 at 4 43 36 PM" src="https://user-images.githubusercontent.com/14225158/80849202-0400ba80-8bcb-11ea-96a5-7caecbf9dbbf.png"> <img width="967" alt="Screen Shot 2020-05-01 at 4 43 54 PM" src="https://user-images.githubusercontent.com/14225158/80849205-06fbab00-8bcb-11ea-8f00-6df52b151684.png"> - **sql-ref-datatypes.md (R)** <img width="967" alt="Screen Shot 2020-05-01 at 4 45 16 PM" src="https://user-images.githubusercontent.com/14225158/80849288-5fcb4380-8bcb-11ea-8277-8589b5bb31bc.png"> <img width="967" alt="Screen Shot 2020-05-01 at 4 45 36 PM" src="https://user-images.githubusercontent.com/14225158/80849294-62c63400-8bcb-11ea-9438-b4f1193bc757.png"> - **sql-ref-datatypes.md (SQL)** <img width="967" alt="Screen Shot 2020-05-01 at 4 48 02 PM" src="https://user-images.githubusercontent.com/14225158/80849336-986b1d00-8bcb-11ea-9736-5fb40496b681.png"> - **sql-ref-syntax-qry-select-tvf.md** <img width="967" alt="Screen Shot 2020-05-01 at 4 49 32 PM" src="https://user-images.githubusercontent.com/14225158/80849399-d10af680-8bcb-11ea-8dc2-e3e750e21a59.png"> ### 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 using jekyll serve Closes #28433 from dilipbiswal/sql-doc-table-cleanup. Authored-by: Dilip Biswal <[email protected]> Signed-off-by: Takeshi Yamamuro <[email protected]> (cherry picked from commit 5052d95) Signed-off-by: Takeshi Yamamuro <[email protected]>

dilipbiswal · 2020-05-05T06:24:12Z

Thanks a lot @maropu @huaxingao @srowen @gatorsmile

maropu · 2020-05-05T06:24:40Z

Thanks! Merged to master/3.0. If @srowen has more comments, please ping @huaxingao so that she can include more fixes in her PR (#28451).

maropu · 2020-05-05T06:25:52Z

Ur, the jira ID is incorrect? @dilipbiswal

dilipbiswal · 2020-05-05T07:13:14Z

@maropu Thanks for fixing the title.

[SPARK-31030] [DOCS] [FOLLOWUP] Replace HTML Table by Markdown Table

4debc83

probot-autolabeler bot added the DOCS label May 1, 2020

huaxingao reviewed May 2, 2020

View reviewed changes

Code review

c419b93

maropu reviewed May 2, 2020

View reviewed changes

Code review

15da96c

maropu approved these changes May 2, 2020

View reviewed changes

srowen reviewed May 2, 2020

View reviewed changes

Code review

028746b

maropu mentioned this pull request May 5, 2020

[SPARK-31429][SQL][DOC] Automatically generates a SQL document for built-in functions #28224

Closed

maropu closed this in 5052d95 May 5, 2020

maropu changed the title ~~[SPARK-31030] [DOCS] [FOLLOWUP] Replace HTML Table by Markdown Table~~ [SPARK-31030][SQL][DOCS][FOLLOWUP] Replace HTML Table by Markdown Table May 5, 2020

[SPARK-31030][SQL][DOCS][FOLLOWUP] Replace HTML Table by Markdown Table #28433

[SPARK-31030][SQL][DOCS][FOLLOWUP] Replace HTML Table by Markdown Table #28433

Uh oh!

Conversation

dilipbiswal commented May 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

Uh oh!

dilipbiswal commented May 1, 2020

Uh oh!

SparkQA commented May 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dilipbiswal commented May 2, 2020

Uh oh!

SparkQA commented May 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maropu commented May 2, 2020

Uh oh!

dilipbiswal commented May 2, 2020

Uh oh!

maropu left a comment

Choose a reason for hiding this comment

Uh oh!

SparkQA commented May 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dilipbiswal May 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SparkQA commented May 2, 2020

Uh oh!

dilipbiswal commented May 5, 2020

Uh oh!

maropu commented May 5, 2020

Uh oh!

dilipbiswal commented May 5, 2020

Uh oh!

maropu commented May 5, 2020

Uh oh!

maropu commented May 5, 2020

Uh oh!

dilipbiswal commented May 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dilipbiswal commented May 1, 2020 •

edited

Loading

dilipbiswal May 2, 2020 •

edited

Loading