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-21210][DOC][ML] Javadoc 8 fixes for ML shared param traits #18420

Closed
wants to merge 1 commit into from

Conversation

MLnick
Copy link
Contributor

@MLnick MLnick commented Jun 26, 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

@MLnick
Copy link
Contributor Author

MLnick commented Jun 26, 2017

cc @HyukjinKwon @srowen

@HyukjinKwon
Copy link
Member

HyukjinKwon commented Jun 26, 2017

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

SparkQA commented Jun 26, 2017

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
Contributor Author

MLnick commented Jun 27, 2017

@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
Contributor Author

MLnick commented Jun 27, 2017

Jenkins retest this please

@SparkQA
Copy link

SparkQA commented Jun 27, 2017

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
Contributor Author

MLnick commented Jun 27, 2017

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

@HyukjinKwon
Copy link
Member

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

@SparkQA
Copy link

SparkQA commented Jun 28, 2017

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
Contributor Author

MLnick commented Jun 29, 2017

Jenkins retest this please

@SparkQA
Copy link

SparkQA commented Jun 29, 2017

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
Member

srowen commented Jun 29, 2017

Merged to master/2.2

@asfgit asfgit closed this in 70085e8 Jun 29, 2017
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 <[email protected]>

Closes #18420 from MLnick/shared-params-javadoc8.

(cherry picked from commit 70085e8)
Signed-off-by: Sean Owen <[email protected]>
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 <[email protected]>

Closes apache#18420 from MLnick/shared-params-javadoc8.
Sign up for free to 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