From 851df770bce4da922e3eb3ad6691c12073d664c9 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Wed, 28 Feb 2024 09:21:17 -0500 Subject: [PATCH] Minor: clarify performance in docs for `ScalarUDF`, `ScalarUDAF` and `ScalarUDWF` --- datafusion/expr/src/udaf.rs | 5 +++-- datafusion/expr/src/udf.rs | 5 +++-- datafusion/expr/src/udwf.rs | 8 +++++--- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/datafusion/expr/src/udaf.rs b/datafusion/expr/src/udaf.rs index 6ff7730bd606..e56723063e41 100644 --- a/datafusion/expr/src/udaf.rs +++ b/datafusion/expr/src/udaf.rs @@ -44,9 +44,10 @@ use std::sync::Arc; /// /// For more information, please see [the examples]: /// -/// 1. For simple (less performant) use cases, use [`create_udaf`] and [`simple_udaf.rs`]. +/// 1. For simple use cases, use [`create_udaf`] (examples in [`simple_udaf.rs`]). /// -/// 2. For advanced use cases, use [`AggregateUDFImpl`] and [`advanced_udaf.rs`]. +/// 2. For advanced use cases, use [`AggregateUDFImpl`] which provides full API +/// access (examples in [`advanced_udaf.rs`]). /// /// # API Note /// This is a separate struct from `AggregateUDFImpl` to maintain backwards diff --git a/datafusion/expr/src/udf.rs b/datafusion/expr/src/udf.rs index 5b5d92a628c2..59e5a7772e02 100644 --- a/datafusion/expr/src/udf.rs +++ b/datafusion/expr/src/udf.rs @@ -37,9 +37,10 @@ use std::sync::Arc; /// functions you supply such name, type signature, return type, and actual /// implementation. /// -/// 1. For simple (less performant) use cases, use [`create_udf`] and [`simple_udf.rs`]. +/// 1. For simple use cases, use [`create_udf`] (examples in [`simple_udf.rs`]). /// -/// 2. For advanced use cases, use [`ScalarUDFImpl`] and [`advanced_udf.rs`]. +/// 2. For advanced use cases, use [`ScalarUDFImpl`] which provides full API +/// access (examples in [`advanced_udf.rs`]). /// /// # API Note /// diff --git a/datafusion/expr/src/udwf.rs b/datafusion/expr/src/udwf.rs index 7e3eb6c001a1..3ab40fe70a91 100644 --- a/datafusion/expr/src/udwf.rs +++ b/datafusion/expr/src/udwf.rs @@ -32,11 +32,13 @@ use std::{ /// Logical representation of a user-defined window function (UDWF) /// A UDWF is different from a UDF in that it is stateful across batches. /// -/// See the documetnation on [`PartitionEvaluator`] for more details +/// See the documentation on [`PartitionEvaluator`] for more details /// -/// 1. For simple (less performant) use cases, use [`create_udwf`] and [`simple_udwf.rs`]. +/// 1. For simple use cases, use [`create_udwf`] (examples in +/// [`simple_udwf.rs`]). /// -/// 2. For advanced use cases, use [`WindowUDFImpl`] and [`advanced_udwf.rs`]. +/// 2. For advanced use cases, use [`WindowUDFImpl`] which provides full API +/// access (examples in [`advanced_udwf.rs`]). /// /// # API Note /// This is a separate struct from `WindowUDFImpl` to maintain backwards