From 2fcbe2465a44708fc500a3f6123dd575f2f07e5c Mon Sep 17 00:00:00 2001
From: vdimir <vdimir@clickhouse.com>
Date: Tue, 20 Aug 2024 09:01:43 +0000
Subject: [PATCH] Fix style in Functions/printf.cpp

---
 src/Functions/printf.cpp                       | 18 ++++++++----------
 ..._new_functions_must_be_documented.reference |  1 -
 2 files changed, 8 insertions(+), 11 deletions(-)

diff --git a/src/Functions/printf.cpp b/src/Functions/printf.cpp
index 3cf3efaf534..afacf164a00 100644
--- a/src/Functions/printf.cpp
+++ b/src/Functions/printf.cpp
@@ -50,13 +50,6 @@ private:
                 return executeNonconstant(input);
         }
 
-        [[maybe_unused]] String toString() const
-        {
-            WriteBufferFromOwnString buf;
-            buf << "format:" << format << ", rows:" << rows << ", is_literal:" << is_literal << ", input:" << input.dumpStructure() << "\n";
-            return buf.str();
-        }
-
     private:
         ColumnWithTypeAndName executeLiteral(std::string_view literal) const
         {
@@ -231,9 +224,7 @@ public:
             const auto & instruction = instructions[i];
             try
             {
-                // std::cout << "instruction[" << i << "]:" << instructions[i].toString() << std::endl;
                 concat_args[i] = instruction.execute();
-                // std::cout << "concat_args[" << i << "]:" << concat_args[i].dumpStructure() << std::endl;
             }
             catch (const fmt::v9::format_error & e)
             {
@@ -358,7 +349,14 @@ private:
 
 REGISTER_FUNCTION(Printf)
 {
-    factory.registerFunction<FunctionPrintf>();
+    factory.registerFunction<FunctionPrintf>(
+        FunctionDocumentation{.description=R"(
+The `printf` function formats the given string with the values (strings, integers, floating-points etc.) listed in the arguments, similar to printf function in C++.
+The format string can contain format specifiers starting with `%` character.
+Anything not contained in `%` and the following format specifier is considered literal text and copied verbatim into the output.
+Literal `%` character can be escaped by `%%`.)", .examples{{"sum", "select printf('%%%s %s %d', 'Hello', 'World', 2024);", "%Hello World 2024"}}, .categories{"String"}
+});
+
 }
 
 }
diff --git a/tests/queries/0_stateless/02415_all_new_functions_must_be_documented.reference b/tests/queries/0_stateless/02415_all_new_functions_must_be_documented.reference
index c39f1fb1ce9..8dd8910c858 100644
--- a/tests/queries/0_stateless/02415_all_new_functions_must_be_documented.reference
+++ b/tests/queries/0_stateless/02415_all_new_functions_must_be_documented.reference
@@ -562,7 +562,6 @@ positionCaseInsensitive
 positionCaseInsensitiveUTF8
 positionUTF8
 pow
-printf
 proportionsZTest
 protocol
 queryID