Docs: add comment for modulo UDF

(cherry picked from commit d2bb743) (cherry picked from commit f4ae4ad)
ClickHouse · Jul 24, 2023 · bb594cb · bb594cb
1 parent d9313e6
commit bb594cb
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/spark-3.4/clickhouse-spark/src/main/scala/xenon/clickhouse/func/clickhouse/Mod.scala b/spark-3.4/clickhouse-spark/src/main/scala/xenon/clickhouse/func/clickhouse/Mod.scala
@@ -26,6 +26,8 @@ object Mod extends UnboundFunction with ScalarFunction[Long] with ClickhouseEqui
 
   override def toString: String = name
 
+  // remainder is not a Clickhouse function, but modulo will be parsed to remainder in the connector.
+  // Added remainder as a synonym.
   override val ckFuncNames: Array[String] = Array("modulo", "remainder")
 
   override def description: String = s"$name: (a: long, b: long) => mod: long"