From f8b56a5a43745839b2ad39e3ccfd5b1bef507303 Mon Sep 17 00:00:00 2001 From: David Li Date: Wed, 5 Jan 2022 09:33:47 -0500 Subject: [PATCH] MINOR: [Docs] Add fill_null functions to docs --- docs/source/cpp/compute.rst | 9 +++++++-- docs/source/python/api/compute.rst | 2 ++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/source/cpp/compute.rst b/docs/source/cpp/compute.rst index ebe2a899d16..2577cf99b7a 100644 --- a/docs/source/cpp/compute.rst +++ b/docs/source/cpp/compute.rst @@ -1687,10 +1687,15 @@ replaced, based on the remaining inputs. +--------------------------+------------+-----------------------+--------------+--------------+--------------+-------+ | Function name | Arity | Input type 1 | Input type 2 | Input type 3 | Output type | Notes | +==========================+============+=======================+==============+==============+==============+=======+ -| replace_with_mask | Ternary | Fixed-width or binary | Boolean | Input type 1 | Input type 1 | \(1) | +| fill_null_backward | Unary | Fixed-width or binary | N/A | N/A | N/A | \(1) | ++--------------------------+------------+-----------------------+--------------+--------------+--------------+-------+ +| fill_null_forward | Unary | Fixed-width or binary | N/A | N/A | N/A | \(1) | ++--------------------------+------------+-----------------------+--------------+--------------+--------------+-------+ +| replace_with_mask | Ternary | Fixed-width or binary | Boolean | Input type 1 | Input type 1 | \(2) | +--------------------------+------------+-----------------------+--------------+--------------+--------------+-------+ -* \(1) Each element in input 1 for which the corresponding Boolean in input 2 +* \(1) Valid values are carried forward/backward to fill null values. +* \(2) Each element in input 1 for which the corresponding Boolean in input 2 is true is replaced with the next value from input 3. A null in input 2 results in a corresponding null in the output. diff --git a/docs/source/python/api/compute.rst b/docs/source/python/api/compute.rst index e9e0d1f4eaa..db817ac3d78 100644 --- a/docs/source/python/api/compute.rst +++ b/docs/source/python/api/compute.rst @@ -475,6 +475,8 @@ Structural Transforms .. autosummary:: :toctree: ../generated/ + fill_null_backward + fill_null_forward list_element list_flatten list_parent_indices