Skip to content

Commit 40a3cd0

Browse files
authored
Minor: improve documentation for IsNotNull, DISTINCT, etc (#8052)
* Minor: improve documentation for IsNotNull, DISTINCT, etc * fix
1 parent b54990d commit 40a3cd0

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

datafusion/expr/src/expr.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,21 +99,21 @@ pub enum Expr {
9999
SimilarTo(Like),
100100
/// Negation of an expression. The expression's type must be a boolean to make sense.
101101
Not(Box<Expr>),
102-
/// Whether an expression is not Null. This expression is never null.
102+
/// True if argument is not NULL, false otherwise. This expression itself is never NULL.
103103
IsNotNull(Box<Expr>),
104-
/// Whether an expression is Null. This expression is never null.
104+
/// True if argument is NULL, false otherwise. This expression itself is never NULL.
105105
IsNull(Box<Expr>),
106-
/// Whether an expression is True. Boolean operation
106+
/// True if argument is true, false otherwise. This expression itself is never NULL.
107107
IsTrue(Box<Expr>),
108-
/// Whether an expression is False. Boolean operation
108+
/// True if argument is false, false otherwise. This expression itself is never NULL.
109109
IsFalse(Box<Expr>),
110-
/// Whether an expression is Unknown. Boolean operation
110+
/// True if argument is NULL, false otherwise. This expression itself is never NULL.
111111
IsUnknown(Box<Expr>),
112-
/// Whether an expression is not True. Boolean operation
112+
/// True if argument is FALSE or NULL, false otherwise. This expression itself is never NULL.
113113
IsNotTrue(Box<Expr>),
114-
/// Whether an expression is not False. Boolean operation
114+
/// True if argument is TRUE OR NULL, false otherwise. This expression itself is never NULL.
115115
IsNotFalse(Box<Expr>),
116-
/// Whether an expression is not Unknown. Boolean operation
116+
/// True if argument is TRUE or FALSE, false otherwise. This expression itself is never NULL.
117117
IsNotUnknown(Box<Expr>),
118118
/// arithmetic negation of an expression, the operand must be of a signed numeric data type
119119
Negative(Box<Expr>),

datafusion/expr/src/operator.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,13 @@ pub enum Operator {
5353
And,
5454
/// Logical OR, like `||`
5555
Or,
56-
/// IS DISTINCT FROM
56+
/// `IS DISTINCT FROM` (see [`distinct`])
57+
///
58+
/// [`distinct`]: arrow::compute::kernels::cmp::distinct
5759
IsDistinctFrom,
58-
/// IS NOT DISTINCT FROM
60+
/// `IS NOT DISTINCT FROM` (see [`not_distinct`])
61+
///
62+
/// [`not_distinct`]: arrow::compute::kernels::cmp::not_distinct
5963
IsNotDistinctFrom,
6064
/// Case sensitive regex match
6165
RegexMatch,

0 commit comments

Comments
 (0)