-
Notifications
You must be signed in to change notification settings - Fork 28.1k
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
[SPARK-13826][SQL] Revises Dataset ScalaDoc #11769
Conversation
Aww... The diff is too large to be displayed, seems that we can't do inline commenting for this one :( |
Test build #53340 has finished for PR 11769 at commit
|
Test build #53341 has finished for PR 11769 at commit
|
How about we break it to multiple PRs? |
The problem is that I reordered many methods so that those in the same group are defined together. Will revert these reordering changes. This can probably shrinks the diff down to acceptable size. |
Test build #53407 has finished for PR 11769 at commit
|
Well, already minimized changes, but still too large to display :( |
Test build #53420 has finished for PR 11769 at commit
|
Test build #53427 has finished for PR 11769 at commit
|
Test build #53429 has finished for PR 11769 at commit
|
Thanks - going to merge this. I found some issues but I will just open a PR to fix them. |
## What changes were proposed in this pull request? This PR revises Dataset API ScalaDoc. All public methods are divided into the following groups * `groupname basic`: Basic Dataset functions * `groupname action`: Actions * `groupname untypedrel`: Untyped Language Integrated Relational Queries * `groupname typedrel`: Typed Language Integrated Relational Queries * `groupname func`: Functional Transformations * `groupname rdd`: RDD Operations * `groupname output`: Output Operations `since` tag and sample code are also updated. We may want to add more sample code for typed APIs. ## How was this patch tested? Documentation change. Checked by building unidoc locally. Author: Cheng Lian <lian@databricks.com> Closes apache#11769 from liancheng/spark-13826-ds-api-doc.
What changes were proposed in this pull request?
This PR revises Dataset API ScalaDoc. All public methods are divided into the following groups
@groupname basic
: Basic Dataset functions@groupname action
: Actions@groupname untypedrel
: Untyped Language Integrated Relational Queries@groupname typedrel
: Typed Language Integrated Relational Queries@groupname func
: Functional Transformations@groupname rdd
: RDD Operations@groupname output
: Output Operations@since
tag and sample code are also updated. We may want to add more sample code for typed APIs.How was this patch tested?
Documentation change. Checked by building unidoc locally.