Skip to content

MINOR: [Docs] Add fill_null functions to docs #12082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lidavidm wants to merge 1 commit into from
Closed

MINOR: [Docs] Add fill_null functions to docs #12082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/source/cpp/compute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/source/python/api/compute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,8 @@ Structural Transforms
.. autosummary::
:toctree: ../generated/

fill_null_backward
fill_null_forward
list_element
list_flatten
list_parent_indices
Expand Down