[
https://issues.apache.org/jira/browse/SPARK-15197?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Sean Owen updated SPARK-15197:
------------------------------
Assignee: Nicholas Tietz
Affects Version/s: 1.6.1
Priority: Minor (was: Major)
Issue Type: Improvement (was: Documentation)
> Improve documentation for countApprox and related functions
> -----------------------------------------------------------
>
> Key: SPARK-15197
> URL: https://issues.apache.org/jira/browse/SPARK-15197
> Project: Spark
> Issue Type: Improvement
> Affects Versions: 1.6.1
> Reporter: Nicholas Tietz
> Assignee: Nicholas Tietz
> Priority: Minor
>
> Within RDD, JavaRDDLike, PairRDDFunctions, and JavaPairRDD, countApprox and
> countByValueApprox are missing Scaladoc on their input parameters and return
> values; in particular, it is unclear what unit the timeout is in and what the
> meaning of the confidence value is.
> We should document these parameters clearly. This includes:
> * documenting the timeout
> * documenting/clarifying the confidence meaning/constraints
> * adding a check in the code to ensure confidence is in the required range
> * clarifying documentation in related methods (such as more detail on
> relativeSD in similar approx methods).
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]