Skip to content

Commit

Permalink
Improve documentation to explain what is different
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Oct 4, 2024
1 parent 8a75ed0 commit 09a4b7b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions datafusion/expr/src/udf_docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ impl DocumentationBuilder {
self
}

/// Adds an argument to the documentation,
/// Adds documentation for a specific argument to the documentation.
///
/// Arguments are displayed in the order they are added.
pub fn with_argument(
mut self,
arg_name: impl Into<String>,
Expand All @@ -145,7 +147,11 @@ impl DocumentationBuilder {

/// Add a standard "expression" argument to the documentation
///
/// This is a common argument for scalar UDFs that operate on an expression and is rendered like
/// This is similar to [`Self::with_argument`] except that a standard
/// description is appended to the end: `"Can be a constant, column, or
/// function, and any combination of arithmetic operators."`
///
/// The argument is rendered like
///
/// ```text
/// <arg_name>:
Expand Down

0 comments on commit 09a4b7b

Please sign in to comment.