alamb commented on code in PR #14544:
URL: https://github.com/apache/datafusion/pull/14544#discussion_r1947818087
##########
docs/source/library-user-guide/adding-udfs.md:
##########
@@ -55,62 +55,138 @@ of arguments.
This a lower level API with more functionality but is more complex, also
documented in [`advanced_udf.rs`].
```rust
+use std::sync::Arc;
use std::any::Any;
+use std::sync::LazyLock;
use arrow::datatypes::DataType;
+use datafusion_common::cast::as_int64_array;
use datafusion_common::{DataFusionError, plan_err, Result};
-use datafusion_expr::{col, ColumnarValue, Signature, Volatility};
+use datafusion_expr::{col, ColumnarValue, Documentation, ScalarFunctionArgs,
Signature, Volatility};
+use datafusion_expr::scalar_doc_sections::DOC_SECTION_MATH;
+use datafusion::arrow::array::{ArrayRef, Int64Array};
use datafusion_expr::{ScalarUDFImpl, ScalarUDF};
+/// This struct for a simple UDF that adds one to an int32
#[derive(Debug)]
struct AddOne {
- signature: Signature
-};
+ signature: Signature,
+}
impl AddOne {
- fn new() -> Self {
- Self {
- signature: Signature::uniform(1, vec![DataType::Int32],
Volatility::Immutable)
- }
- }
+ fn new() -> Self {
+ Self {
+ signature: Signature::uniform(1, vec![DataType::Int32],
Volatility::Immutable),
+ }
+ }
}
+static DOCUMENTATION: LazyLock<Documentation> = LazyLock::new(|| {
Review Comment:
It is called `user_doc`
Here is an example:
https://github.com/apache/datafusion/blob/bd7daffe0c8643f008689f097eb887f09d063e7e/datafusion/functions/src/string/btrim.rs#L37-L59
--
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: github-unsubscr...@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For additional commands, e-mail: github-h...@datafusion.apache.org
