(spark) branch master updated: [MINOR][DOCS] Fix usage doc for mod

[gu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 1f83f4d89eb7 [MINOR][DOCS] Fix usage doc for mod
1f83f4d89eb7 is described below

commit 1f83f4d89eb7a50a427478c9d3861575b7753c64
Author: Kent Yao <ya...@apache.org>
AuthorDate: Thu May 30 09:16:58 2024 +0900

    [MINOR][DOCS] Fix usage doc for mod
    
    ### What changes were proposed in this pull request?
    
    This PR fixes wrong expression desc for `mod`
    
    'expr1 mod expr2 - Returns the remainder after `expr1`/`expr2`'. https://spark.apache.org/docs/latest/api/sql/index.html#mod
    
    ### Why are the changes needed?
    
    docfix
    
    ### Does this PR introduce _any_ user-facing change?
    
    no
    ### How was this patch tested?
    
    doc build
    ### Was this patch authored or co-authored using generative AI tooling?
    
    no
    
    Closes #46787 from yaooqinn/minor.
    
    Authored-by: Kent Yao <ya...@apache.org>
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
 .../scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala
index 65ab42f859ca..2ad917567f3a 100644
--- a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala
+++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala
@@ -886,7 +886,7 @@ case class IntegralDivide(
 }
 
 @ExpressionDescription(
-  usage = "expr1 _FUNC_ expr2 - Returns the remainder after `expr1`/`expr2`.",
+  usage = "expr1 % expr2, or mod(expr1, expr2) - Returns the remainder after `expr1`/`expr2`.",
   examples = """
     Examples:
       > SELECT 2 % 1.8;


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