[jira] [Commented] (SPARK-11605) ML 1.6 QA: API: Java compatibility, docs

["Joseph K. Bradley (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-11605?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15033213#comment-15033213 ] 

Joseph K. Bradley commented on SPARK-11605:
-------------------------------------------

private[ml] functions can be ignored.  It's a shame that they are public in Java, but at least they do not show up in the Java doc.

> ML 1.6 QA: API: Java compatibility, docs
> ----------------------------------------
>
>                 Key: SPARK-11605
>                 URL: https://issues.apache.org/jira/browse/SPARK-11605
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, Java API, ML, MLlib
>            Reporter: Joseph K. Bradley
>            Assignee: yuhao yang
>
> Check Java compatibility for MLlib for this release.
> Checking compatibility means:
> * comparing with the Scala doc
> * verifying that Java docs are not messed up by Scala type incompatibilities.  Some items to look out for are:
> ** Check for generic "Object" types where Java cannot understand complex Scala types.
> *** *Note*: The Java docs do not always match the bytecode. If you find a problem, please verify it using {{javap}}.
> ** Check Scala objects (especially with nesting!) carefully.
> ** Check for uses of Scala and Java enumerations, which can show up oddly in the other language's doc.
> * If needed for complex issues, create small Java unit tests which execute each method.  (The correctness can be checked in Scala.)
> If you find issues, please comment here, or for larger items, create separate JIRAs and link here.
> Note that we should not break APIs from previous releases.  So if you find a problem, check if it was introduced in this Spark release (in which case we can fix it) or in a previous one (in which case we can create a java-friendly version of the API).



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org