[SPARK-23861][SQL][Doc] Clarify default window frame with and without orderBy clause

[icexelloss]

What changes were proposed in this pull request?

Add docstring to clarify default window frame boundaries with and without orderBy clause

How was this patch tested?

Manually generate doc and check.

[icexelloss]

cc @jiangxb1987 @hvanhovell

[icexelloss]

Added doc per discussion on mailing list. Sorry that I have not generated scaladoc before, what's the best way to generate scaladoc locally?

[SparkQA]

Test build #88896 has finished for PR 20978 at commit f96eaea.

• This patch fails Spark unit tests.
• This patch merges cleanly.
• This patch adds no public classes.

[SparkQA]

Test build #88895 has finished for PR 20978 at commit 0b6f5fc.

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

[felixcheung]

PRODUCTION=1 RELEASE_VERSION="$SPARK_VERSION" jekyll build
and https://github.com/apache/spark/tree/master/docs#api-docs-scaladoc-javadoc-sphinx-roxygen2-mkdocs

[hvanhovell]

I tried to improve the wording (feel free not to use this):

When ordering is not defined, an unbounded window frame (rowFrame, unboundedPreceding, unboundedFollowing) is used by default. When ordering is defined, a growing window frame (rangeFrame, unboundedPreceding, currentRow) is used by default.

[icexelloss]

I think your wording is better. Updated.

[icexelloss]

[icexelloss]

@felixcheung Thanks much for the tips! I was able to generate scaladoc using sbt unidoc but for some reason my local changes are not reflected in the generated doc (I tried deleted the generated do and regenerate, but still no luck). I wonder I am missing sth?

[SparkQA]

Test build #88956 has finished for PR 20978 at commit 8fb7527.

• This patch fails Spark unit tests.
• This patch merges cleanly.
• This patch adds no public classes.

[icexelloss]

jenkins retest please

[HyukjinKwon]

retest this please

[SparkQA]

Test build #88981 has finished for PR 20978 at commit 8fb7527.

• This patch fails Spark unit tests.
• This patch merges cleanly.
• This patch adds no public classes.

[hvanhovell]

retest this please

[hvanhovell]

it makes very little sense that this keeps failing

[icexelloss]

@hvanhovell @HyukjinKwon thanks for helping with the build! I think this PR is ready except for that I still couldn't figure out why sbt unidoc isn't producing the updated the doc. I could be reading wrong but it seems like it uses the github as source to build docs:
https://github.com/apache/spark/blob/master/project/SparkBuild.scala#L727

Do you have suggestion how do I build the doc from local source?

[SparkQA]

Test build #88983 has finished for PR 20978 at commit 8fb7527.

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

[hvanhovell]

Merging to master. Thanks!

[HyukjinKwon]

LGTM :)

[HyukjinKwon]

and .. I guess @hvanhovell is hitting a network issue? I just merged it into master.

[hvanhovell]

Yeah, I got distracted. Thanks for merging.

[icexelloss]

Thanks all!

[felixcheung]

Nay unidocSourceBase is just for web links in the doc. Have you tried PRODUCTION=1 RELEASE_VERSION="$SPARK_VERSION" jekyll build