diff --git a/sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java b/sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java index 0f648ab9d7d2..089fbe53d517 100644 --- a/sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java +++ b/sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java @@ -79,8 +79,8 @@ * * * - * We can refer the function name by `_FUNC_`, in `usage()`, `arguments()` and `examples()` as - * it is registered in `FunctionRegistry`. + * We can refer the function name by `_FUNC_`, in `usage()`, `arguments()`, `examples()` and + * `note()` as it is registered in `FunctionRegistry`. * * Note that, if `extended()` is defined, `arguments()`, `examples()`, `note()`, `group()`, * `since()` and `deprecated()` should be not defined together. `extended()` exists diff --git a/sql/gen-sql-api-docs.py b/sql/gen-sql-api-docs.py index 3095a51e82d7..61328997c1c5 100644 --- a/sql/gen-sql-api-docs.py +++ b/sql/gen-sql-api-docs.py @@ -43,7 +43,7 @@ def _list_function_infos(jvm): usage=usage, arguments=jinfo.getArguments().replace("_FUNC_", name), examples=jinfo.getExamples().replace("_FUNC_", name), - note=jinfo.getNote(), + note=jinfo.getNote().replace("_FUNC_", name), since=jinfo.getSince(), deprecated=jinfo.getDeprecated())) return sorted(infos, key=lambda i: i.name)