[GitHub] [datasketches-hive] okumin commented on a diff in pull request #66: Add @Description to UDFs registered in Apache Hive

["okumin (via GitHub)" <gi...@apache.org>]

okumin commented on code in PR #66:
URL: https://github.com/apache/datasketches-hive/pull/66#discussion_r1114195982


##########
src/main/java/org/apache/datasketches/hive/cpc/UnionSketchUDF.java:
##########
@@ -24,12 +24,22 @@
 import org.apache.datasketches.cpc.CpcSketch;
 import org.apache.datasketches.cpc.CpcUnion;
 import org.apache.datasketches.hive.common.BytesWritableHelper;
+import org.apache.hadoop.hive.ql.exec.Description;
 import org.apache.hadoop.hive.ql.exec.UDF;
 import org.apache.hadoop.io.BytesWritable;
 
 /**
  * Hive union sketch UDF.
  */
+@Description(
+    name = "unionSketch",
+    value = "_FUNC_(firstSketch, secondSketch[, lgK[, seed]]) - Compute the union of the given "
+        + "sketches with the given size and seed",
+    extended = "The return value is a binary blob that can be operated on by other sketch related functions."
+        + " The lgK parameter controls the sketch size and rlative error expected from the sketch."

Review Comment:
   Thanks. I fixed all typos. Please let me know if you prefer to have separate PRs.
   https://github.com/apache/datasketches-hive/pull/66/commits/e3bafbe37aecd3566369676299cf1c5437374d54
   
   ```
   $ git grep rlative
   src/main/java/org/apache/datasketches/hive/cpc/DataToSketchUDAF.java:    + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   src/main/java/org/apache/datasketches/hive/cpc/UnionSketchUDAF.java:    + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   src/main/java/org/apache/datasketches/hive/cpc/UnionSketchUDF.java:        + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   src/main/java/org/apache/datasketches/hive/hll/DataToSketchUDAF.java:    + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   src/main/java/org/apache/datasketches/hive/hll/UnionSketchUDAF.java:    + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   src/main/java/org/apache/datasketches/hive/hll/UnionSketchUDF.java:        + " The lgK parameter controls the sketch size and rlative error expected from the sketch."
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org