Skip to content

[SPARK-5730][ML] add doc groups to spark.ml components #4600

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

[SPARK-5730][ML] add doc groups to spark.ml components #4600

wants to merge 1 commit into from

Conversation

mengxr
Copy link
Contributor

@mengxr mengxr commented Feb 13, 2015

This PR adds three groups to the ScalaDoc: param, setParam, and getParam. Params will show up in the generated Scala API doc as the top group. Setters/getters will be at the bottom.

Preview:

screen shot 2015-02-13 at 2 47 49 pm

@SparkQA
Copy link

SparkQA commented Feb 13, 2015

Test build #27460 has started for PR 4600 at commit febed9a.

  • This patch merges cleanly.

@SparkQA
Copy link

SparkQA commented Feb 14, 2015

Test build #27460 has finished for PR 4600 at commit febed9a.

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

@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/27460/
Test PASSed.

asfgit pushed a commit that referenced this pull request Feb 14, 2015
@mengxr
[SPARK-5730][ML] add doc groups to spark.ml components
fccd38d 
This PR adds three groups to the ScalaDoc: `param`, `setParam`, and `getParam`. Params will show up in the generated Scala API doc as the top group. Setters/getters will be at the bottom.

Preview:

![screen shot 2015-02-13 at 2 47 49 pm](https://cloud.githubusercontent.com/assets/829644/6196657/5740c240-b38f-11e4-94bb-bd8ef5a796c5.png)

Author: Xiangrui Meng <meng@databricks.com>

Closes #4600 from mengxr/SPARK-5730 and squashes the following commits:

febed9a [Xiangrui Meng] add doc groups to spark.ml components

(cherry picked from commit 4f4c6d5)
Signed-off-by: Xiangrui Meng <meng@databricks.com>
@mengxr
Copy link
Contributor Author

mengxr commented Feb 14, 2015

Merged into master and branch-1.3.

@asfgit asfgit closed this in 4f4c6d5 Feb 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mengxr @SparkQA @AmplabJenkins