Skip to content

Commit 7436e2c

Browse files
committed
fix infallible docs
Signed-off-by: Connor Tsui <[email protected]>
1 parent d2c1d29 commit 7436e2c

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

  • vortex-array/src/scalar_fn/unstable/row

‎vortex-array/src/scalar_fn/unstable/row/row_fn.rs‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,17 @@ pub trait RowFn: 'static + Sized + Clone + Send + Sync {
4747
/// The arguments in display order. Its length is the function's exact arity.
4848
const ARG_NAMES: &'static [&'static str];
4949

50-
/// Whether the row operation selected by every dispatch is infallible.
50+
/// Whether every row operation selected by [`dispatch`](Self::dispatch) is semantically
51+
/// infallible.
5152
///
52-
/// See [`ScalarFnVTable::is_infallible`](crate::scalar_fn::ScalarFnVTable::is_infallible) for
53-
/// a more detailed explanation of semantic errors.
53+
/// Input decoding declares its fallibility independently through
54+
/// [`InputElement::DECODE_INFALLIBLE`] and does not affect this flag. The framework checks
55+
/// row-result fallibility. A conservative `false` is allowed.
5456
///
55-
/// Input decoding fallibility is declared separately by
56-
/// [`InputElement::DECODE_INFALLIBLE`](crate::scalar_fn::unstable::row::InputElement::DECODE_INFALLIBLE)
57-
/// and does not affect this flag. The framework checks dispatched result types. A conservative
58-
/// `false` is allowed.
57+
/// See [`ScalarFnVTable::is_infallible`] for the definition of semantic errors.
58+
///
59+
/// [`InputElement::DECODE_INFALLIBLE`]: crate::scalar_fn::unstable::row::InputElement::DECODE_INFALLIBLE
60+
/// [`ScalarFnVTable::is_infallible`]: crate::scalar_fn::ScalarFnVTable::is_infallible
5961
const INFALLIBLE: bool;
6062

6163
/// Returns the ID of the scalar function.

0 commit comments

Comments
 (0)