Github user HyukjinKwon commented on a diff in the pull request:
https://github.com/apache/spark/pull/12135#discussion_r99040876
--- Diff:
sql/core/src/main/scala/org/apache/spark/sql/DataFrameStatFunctions.scala ---
@@ -75,13 +76,43 @@ final class DataFrameStatFunctions private[sql](df:
DataFrame) {
}
/**
+ * Calculates the approximate quantiles of numerical columns of a
DataFrame.
+ * @see [[DataFrameStatsFunctions.approxQuantile(col:Str*
approxQuantile]] for
+ * detailed description.
+ *
+ * Note that rows containing any null or NaN values values will be
removed before
+ * calculation.
+ * @param cols the names of the numerical columns
+ * @param probabilities a list of quantile probabilities
+ * Each number must belong to [0, 1].
+ * For example 0 is the minimum, 0.5 is the median, 1 is the maximum.
+ * @param relativeError The relative target precision to achieve (>= 0).
--- End diff --
As a kind comment to inform as I know it is super easy for javadoc8 to be
broken It seems javadoc8 complains it as below:
```
[error]
.../spark/sql/core/target/java/org/apache/spark/sql/DataFrameStatFunctions.java:43:
error: unexpected content
[error] * @see {@link DataFrameStatsFunctions.approxQuantile(col:Str*
approxQuantile} for
[error] ^
[error]
.../spark/sql/core/target/java/org/apache/spark/sql/DataFrameStatFunctions.java:52:
error: bad use of '>'
[error] * @param relativeError The relative target precision to achieve
(>= 0).
[error]
```
We could do this as
```
@param relativeError The relative target precision to achieve (greater or
equal to 0).
```
and fix the link as below _If there is no better choice_:
```
@see `DataFrameStatsFunctions.approxQuantile` for detailed description.
```
Just FYI, there are several cases in
https://github.com/apache/spark/pull/16013
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
