Skip to content

[SPARK-21210][DOC][ML] Javadoc 8 fixes for ML shared param traits - #18420

Closed
MLnick wants to merge 1 commit into
apache:masterfrom
MLnick:shared-params-javadoc8
Closed

[SPARK-21210][DOC][ML] Javadoc 8 fixes for ML shared param traits#18420
MLnick wants to merge 1 commit into
apache:masterfrom
MLnick:shared-params-javadoc8

Conversation

@MLnick

Copy link
Copy Markdown
Contributor

PR #15999 included fixes for doc strings in the ML shared param traits (occurrences of > and >=).

This PR simply uses the HTML-escaped version of the param doc to embed into the Scaladoc, to ensure that when SharedParamsCodeGen is run, the generated javadoc will be compliant for Java 8.

How was this patch tested?

Existing tests

@MLnick

Copy link
Copy Markdown
ContributorAuthor

cc @HyukjinKwon@srowen

@HyukjinKwon

HyukjinKwon commented Jun 26, 2017

Copy link
Copy Markdown
Member

Just as a little side note, actually, while fixing some javadoc at that time, I realised that even > and < are not actually rendered pretty - #16013 (comment) but I guess here these documentation is privates not exposed in Javadoc where the rendering was problematic. So, I think this's not a big deal here and the change looks minimised and clean.

LGTM.

@SparkQA

Copy link
Copy Markdown

Test build #78637 has finished for PR 18420 at commit 9c24515.

  • This patch fails due to an unknown error code, -10.
  • This patch merges cleanly.
  • This patch adds no public classes.

@MLnick

Copy link
Copy Markdown
ContributorAuthor

@HyukjinKwon true it is private. But there is the possibility that (at least some of) these shared params are made public in the future. So worth doing I guess.

@MLnick

Copy link
Copy Markdown
ContributorAuthor

Jenkins retest this please

@SparkQA

Copy link
Copy Markdown

Test build #78684 has finished for PR 18420 at commit 9c24515.

  • This patch fails PySpark pip packaging tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@MLnick

Copy link
Copy Markdown
ContributorAuthor

Will wait for pip tests to get sorted out before trying again!

@HyukjinKwon

Copy link
Copy Markdown
Member

Sad ... I guess it fails only on some environments in Jenkins BTW.

@SparkQA

Copy link
Copy Markdown

Test build #3817 has finished for PR 18420 at commit 9c24515.

  • This patch fails PySpark pip packaging tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@MLnick

Copy link
Copy Markdown
ContributorAuthor

Jenkins retest this please

@SparkQA

Copy link
Copy Markdown

Test build #78885 has finished for PR 18420 at commit 9c24515.

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

@srowen

Copy link
Copy Markdown
Member

Merged to master/2.2

asfgit pushed a commit that referenced this pull request Jun 29, 2017
PR #15999 included fixes for doc strings in the ML shared param traits (occurrences of `>` and `>=`).
This PR simply uses the HTML-escaped version of the param doc to embed into the Scaladoc, to ensure that when `SharedParamsCodeGen` is run, the generated javadoc will be compliant for Java 8.
## How was this patch tested?
Existing tests
Author: Nick Pentreath <nickp@za.ibm.com>
Closes#18420 from MLnick/shared-params-javadoc8.
(cherry picked from commit 70085e8)
Signed-off-by: Sean Owen <sowen@cloudera.com>
robert3005 pushed a commit to palantir/spark that referenced this pull request Jun 29, 2017
PR apache#15999 included fixes for doc strings in the ML shared param traits (occurrences of `>` and `>=`).
This PR simply uses the HTML-escaped version of the param doc to embed into the Scaladoc, to ensure that when `SharedParamsCodeGen` is run, the generated javadoc will be compliant for Java 8.
## How was this patch tested?
Existing tests
Author: Nick Pentreath <nickp@za.ibm.com>
Closesapache#18420 from MLnick/shared-params-javadoc8.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@MLnick@HyukjinKwon@SparkQA@srowen