Apache DataFusion SQL Query Engine
chore: Format examples in doc strings - functions (#18353)
Yu-Chuan Hung69e189dcff06
diff --git a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator.rs b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator.rsindex aa2f5a586e..c807591dab 100644--- a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator.rs+++ b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator.rs@@ -80,15 +80,13 @@ use datafusion_expr_common::groups_accumulator::{EmitTo, GroupsAccumulator};/// Logical group Current Min/Max value for that group stored/// number as a ScalarValue which points to an/// individually allocated String-///-///```+/// ```////// # Optimizations////// The adapter minimizes the number of calls to [`Accumulator::update_batch`]/// by first collecting the input rows for each group into a contiguous array/// using [`compute::take`]-///pub struct GroupsAccumulatorAdapter {factory: Box<dyn Fn() -> Result<Box<dyn Accumulator>> + Send>,@@ -184,7 +182,6 @@ impl GroupsAccumulatorAdapter {/// └─────────┘ └─────────┘ └ ─ ─ ─ ─ ┘ └─────────┘ └ ─ ─ ─ ─ ┘////// logical group values opt_filter logical group values opt_filter- ////// ```fn invoke_per_accumulator<F>(&mut self,diff --git a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/accumulate.rs b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/accumulate.rsindex 987ba57f77..736345874c 100644--- a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/accumulate.rs+++ b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/accumulate.rs@@ -760,7 +760,6 @@ mod test {/// Calls `NullState::accumulate` and `accumulate_indices` to/// ensure it generates the correct values.- ///fn accumulate_test(group_indices: &[usize],values: &UInt32Array,diff --git a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/prim_op.rs b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/prim_op.rsindex 078982c983..fe920927f3 100644--- a/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/prim_op.rs+++ b/datafusion/functions-aggregate-common/src/aggregate/groups_accumulator/prim_op.rs@@ -142,7 +142,6 @@ where/// The state is:/// - self.prim_fn for all non null, non filtered values/// - null otherwise- ///fn convert_to_state(&self,values: &[ArrayRef],diff --git a/datafusion/functions-aggregate-common/src/tdigest.rs b/datafusion/functions-aggregate-common/src/tdigest.rsindex 370a640b04..320157fb7b 100644--- a/datafusion/functions-aggregate-common/src/tdigest.rs+++ b/datafusion/functions-aggregate-common/src/tdigest.rs@@ -575,7 +575,6 @@ impl TDigest {/// │└ ─ ─ ─ ┘│/// │ │/// ...- ////// ```////// The [`TDigest::from_scalar_state()`] method reverses this processes,diff --git a/datafusion/functions-aggregate/src/count.rs b/datafusion/functions-aggregate/src/count.rsindex 065635a891..a291e8e21e 100644--- a/datafusion/functions-aggregate/src/count.rs+++ b/datafusion/functions-aggregate/src/count.rs@@ -113,8 +113,8 @@ pub fn count_all() -> Expr {/// // create `count(*)` OVER ... window function expression/// let expr = count_all_window();/// assert_eq!(-/// expr.schema_name().to_string(),-/// "count(Int64(1)) ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING"+/// expr.schema_name().to_string(),+/// "count(Int64(1)) ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING"/// );/// // if you need to refer to this column, use the `schema_name` function/// let expr = col(expr.schema_name().to_string());diff --git a/datafusion/functions-aggregate/src/median.rs b/datafusion/functions-aggregate/src/median.rsindex 9466c6affb..8c524c2f15 100644--- a/datafusion/functions-aggregate/src/median.rs+++ b/datafusion/functions-aggregate/src/median.rs@@ -302,7 +302,6 @@ impl<T: ArrowNumericType> Accumulator for MedianAccumulator<T> {/// of groups before final evaluation./// So values in each group will be stored in a `Vec<T>`, and the total group values/// will be actually organized as a `Vec<Vec<T>>`.-///#[derive(Debug)]struct MedianGroupsAccumulator<T: ArrowNumericType + Send> {data_type: DataType,diff --git a/datafusion/functions-aggregate/src/percentile_cont.rs b/datafusion/functions-aggregate/src/percentile_cont.rsindex 545d13b401..7ef0f8baf0 100644--- a/datafusion/functions-aggregate/src/percentile_cont.rs+++ b/datafusion/functions-aggregate/src/percentile_cont.rs@@ -457,7 +457,6 @@ impl<T: ArrowNumericType> Accumulator for PercentileContAccumulator<T> {/// of groups before final evaluation./// So values in each group will be stored in a `Vec<T>`, and the total group values/// will be actually organized as a `Vec<Vec<T>>`.-///#[derive(Debug)]struct PercentileContGroupsAccumulator<T: ArrowNumericType + Send> {data_type: DataType,diff --git a/datafusion/functions-nested/src/expr_ext.rs b/datafusion/functions-nested/src/expr_ext.rsindex 4da4a3f583..18c4c5fb59 100644--- a/datafusion/functions-nested/src/expr_ext.rs+++ b/datafusion/functions-nested/src/expr_ext.rs@@ -36,8 +36,7 @@ use crate::extract::{array_element, array_slice};/// ```/// # use datafusion_expr::{lit, col, Expr};/// # use datafusion_functions_nested::expr_ext::IndexAccessor;-/// let expr = col("c1")-/// .index(lit(3));+/// let expr = col("c1").index(lit(3));/// assert_eq!(expr.schema_name().to_string(), "c1[Int32(3)]");/// ```pub trait IndexAccessor {@@ -66,8 +65,7 @@ impl IndexAccessor for Expr {/// ```/// # use datafusion_expr::{lit, col};/// # use datafusion_functions_nested::expr_ext::SliceAccessor;-/// let expr = col("c1")-/// .range(lit(2), lit(4));+/// let expr = col("c1").range(lit(2), lit(4));/// assert_eq!(expr.schema_name().to_string(), "c1[Int32(2):Int32(4)]");/// ```pub trait SliceAccessor {diff --git a/datafusion/functions-nested/src/lib.rs b/datafusion/functions-nested/src/lib.rsindex 0a549fb294..3a66e65694 100644--- a/datafusion/functions-nested/src/lib.rs+++ b/datafusion/functions-nested/src/lib.rs@@ -32,7 +32,6 @@//! [DataFusion]: https://crates.io/crates/datafusion//!//! You can register the functions in this crate using the [`register_all`] function.-//!#[macro_use]pub mod macros;diff --git a/datafusion/functions-window-common/src/expr.rs b/datafusion/functions-window-common/src/expr.rsindex d72cd412f0..7ae43906c4 100644--- a/datafusion/functions-window-common/src/expr.rs+++ b/datafusion/functions-window-common/src/expr.rs@@ -39,7 +39,6 @@ impl<'a> ExpressionArgs<'a> {/// to the user-defined window function./// * `input_fields` - The fields corresponding to the/// arguments to the user-defined window function.- ///pub fn new(input_exprs: &'a [Arc<dyn PhysicalExpr>],input_fields: &'a [FieldRef],diff --git a/datafusion/functions-window-common/src/field.rs b/datafusion/functions-window-common/src/field.rsindex 8d22efa3bc..8e33930ff7 100644--- a/datafusion/functions-window-common/src/field.rs+++ b/datafusion/functions-window-common/src/field.rs@@ -36,7 +36,6 @@ impl<'a> WindowUDFFieldArgs<'a> {/// arguments to the user-defined window function./// * `function_name` - The qualified schema name of the/// user-defined window function expression.- ///pub fn new(input_fields: &'a [FieldRef], display_name: &'a str) -> Self {WindowUDFFieldArgs {input_fields,diff --git a/datafusion/functions-window-common/src/partition.rs b/datafusion/functions-window-common/src/partition.rsindex df0a815401..463419d5f0 100644--- a/datafusion/functions-window-common/src/partition.rs+++ b/datafusion/functions-window-common/src/partition.rs@@ -48,7 +48,6 @@ impl<'a> PartitionEvaluatorArgs<'a> {/// window function is reversible and is reversed./// * `ignore_nulls` - Set to `true` when `IGNORE NULLS` is/// specified.- ///pub fn new(input_exprs: &'a [Arc<dyn PhysicalExpr>],input_fields: &'a [FieldRef],diff --git a/datafusion/functions-window/src/lib.rs b/datafusion/functions-window/src/lib.rsindex 139ace4bf7..0093a1c235 100644--- a/datafusion/functions-window/src/lib.rs+++ b/datafusion/functions-window/src/lib.rs@@ -30,7 +30,6 @@//! implemented using the extension API.//!//! [DataFusion]: https://crates.io/crates/datafusion-//!use std::sync::Arc;diff --git a/datafusion/functions/benches/ltrim.rs b/datafusion/functions/benches/ltrim.rsindex 2712223506..b9fed57219 100644--- a/datafusion/functions/benches/ltrim.rs+++ b/datafusion/functions/benches/ltrim.rs@@ -100,7 +100,6 @@ pub fn create_string_array_and_characters(/// Outputs:/// - testing string array/// - trimmed characters-///fn create_args(size: usize,characters: &str,diff --git a/datafusion/functions/src/core/expr_ext.rs b/datafusion/functions/src/core/expr_ext.rsindex af05f447f1..3b8581995a 100644--- a/datafusion/functions/src/core/expr_ext.rs+++ b/datafusion/functions/src/core/expr_ext.rs@@ -39,8 +39,7 @@ use super::expr_fn::get_field;/// ```/// # use datafusion_expr::{col};/// # use datafusion_functions::core::expr_ext::FieldAccessor;-/// let expr = col("c1")-/// .field("my_field");+/// let expr = col("c1").field("my_field");/// assert_eq!(expr.schema_name().to_string(), "c1[my_field]");/// ```pub trait FieldAccessor {diff --git a/datafusion/functions/src/core/nullif.rs b/datafusion/functions/src/core/nullif.rsindex be2dd0d2ca..69d86360cb 100644--- a/datafusion/functions/src/core/nullif.rs+++ b/datafusion/functions/src/core/nullif.rs@@ -113,7 +113,6 @@ impl ScalarUDFImpl for NullIfFunc {/// Implements NULLIF(expr1, expr2)/// Args: 0 - left expr is any array/// 1 - if the left is equal to this expr2, then the result is NULL, otherwise left value is passed.-///fn nullif_func(args: &[ColumnarValue]) -> Result<ColumnarValue> {let [lhs, rhs] = take_function_args("nullif", args)?;diff --git a/datafusion/functions/src/datetime/common.rs b/datafusion/functions/src/datetime/common.rsindex 65f9c93239..90b92a7f88 100644--- a/datafusion/functions/src/datetime/common.rs+++ b/datafusion/functions/src/datetime/common.rs@@ -140,7 +140,6 @@ pub(crate) fn string_to_datetime_formatted<T: TimeZone>(/// defined by `chrono`.////// [`chrono::format::strftime`]: https://docs.rs/chrono/latest/chrono/format/strftime/index.html-///#[inline]pub(crate) fn string_to_timestamp_nanos_formatted(s: &str,@@ -169,7 +168,6 @@ pub(crate) fn string_to_timestamp_nanos_formatted(/// defined by `chrono`.////// [`chrono::format::strftime`]: https://docs.rs/chrono/latest/chrono/format/strftime/index.html-///#[inline]pub(crate) fn string_to_timestamp_millis_formatted(s: &str, format: &str) -> Result<i64> {Ok(string_to_datetime_formatted(&Utc, s, format)?