Skip to content
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

Closed
wants to merge 6 commits into from

Conversation

liancheng
Copy link
Contributor

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.

@liancheng
Copy link
Contributor Author

cc @rxin @marmbrus @yhuai

@liancheng
Copy link
Contributor Author

Aww... The diff is too large to be displayed, seems that we can't do inline commenting for this one :(

@SparkQA
Copy link

SparkQA commented Mar 16, 2016

Test build #53340 has finished for PR 11769 at commit eae6641.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):
    • * case class Book(title: String, words: String)
    • * case class Word(word: String)

@SparkQA
Copy link

SparkQA commented Mar 16, 2016

Test build #53341 has finished for PR 11769 at commit 4fcf4e2.

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

@yhuai
Copy link
Contributor

yhuai commented Mar 16, 2016

How about we break it to multiple PRs?

@liancheng
Copy link
Contributor Author

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.

@SparkQA
Copy link

SparkQA commented Mar 17, 2016

Test build #53407 has finished for PR 11769 at commit 6062f49.

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

@liancheng
Copy link
Contributor Author

Well, already minimized changes, but still too large to display :(

@SparkQA
Copy link

SparkQA commented Mar 17, 2016

Test build #53420 has finished for PR 11769 at commit 5b7279f.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):
    • * case class Book(title: String, words: String)
    • * case class Word(word: String)

@SparkQA
Copy link

SparkQA commented Mar 17, 2016

Test build #53427 has finished for PR 11769 at commit 50502a5.

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

@SparkQA
Copy link

SparkQA commented Mar 17, 2016

Test build #53429 has finished for PR 11769 at commit 1c02a2e.

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

@rxin
Copy link
Contributor

rxin commented Mar 18, 2016

Thanks - going to merge this. I found some issues but I will just open a PR to fix them.

@asfgit asfgit closed this in 10ef4f3 Mar 18, 2016
@liancheng liancheng deleted the spark-13826-ds-api-doc branch March 21, 2016 23:50
roygao94 pushed a commit to roygao94/spark that referenced this pull request Mar 22, 2016
## 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants