Skip to content

Commit

Permalink
Minor: improve documentation for IsNotNull, DISTINCT, etc (#8052)
Browse files Browse the repository at this point in the history
* Minor: improve documentation for IsNotNull, DISTINCT, etc

* fix
  • Loading branch information
alamb committed Nov 6, 2023
1 parent b54990d commit 40a3cd0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
16 changes: 8 additions & 8 deletions datafusion/expr/src/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,21 @@ pub enum Expr {
SimilarTo(Like),
/// Negation of an expression. The expression's type must be a boolean to make sense.
Not(Box<Expr>),
/// Whether an expression is not Null. This expression is never null.
/// True if argument is not NULL, false otherwise. This expression itself is never NULL.
IsNotNull(Box<Expr>),
/// Whether an expression is Null. This expression is never null.
/// True if argument is NULL, false otherwise. This expression itself is never NULL.
IsNull(Box<Expr>),
/// Whether an expression is True. Boolean operation
/// True if argument is true, false otherwise. This expression itself is never NULL.
IsTrue(Box<Expr>),
/// Whether an expression is False. Boolean operation
/// True if argument is false, false otherwise. This expression itself is never NULL.
IsFalse(Box<Expr>),
/// Whether an expression is Unknown. Boolean operation
/// True if argument is NULL, false otherwise. This expression itself is never NULL.
IsUnknown(Box<Expr>),
/// Whether an expression is not True. Boolean operation
/// True if argument is FALSE or NULL, false otherwise. This expression itself is never NULL.
IsNotTrue(Box<Expr>),
/// Whether an expression is not False. Boolean operation
/// True if argument is TRUE OR NULL, false otherwise. This expression itself is never NULL.
IsNotFalse(Box<Expr>),
/// Whether an expression is not Unknown. Boolean operation
/// True if argument is TRUE or FALSE, false otherwise. This expression itself is never NULL.
IsNotUnknown(Box<Expr>),
/// arithmetic negation of an expression, the operand must be of a signed numeric data type
Negative(Box<Expr>),
Expand Down
8 changes: 6 additions & 2 deletions datafusion/expr/src/operator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@ pub enum Operator {
And,
/// Logical OR, like `||`
Or,
/// IS DISTINCT FROM
/// `IS DISTINCT FROM` (see [`distinct`])
///
/// [`distinct`]: arrow::compute::kernels::cmp::distinct
IsDistinctFrom,
/// IS NOT DISTINCT FROM
/// `IS NOT DISTINCT FROM` (see [`not_distinct`])
///
/// [`not_distinct`]: arrow::compute::kernels::cmp::not_distinct
IsNotDistinctFrom,
/// Case sensitive regex match
RegexMatch,
Expand Down

0 comments on commit 40a3cd0

Please sign in to comment.