Skip to content

Commit

Permalink
DOC: Add sort to the documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Berg <[email protected]>
  • Loading branch information
seberg committed Jan 17, 2025
1 parent 23145ae commit 64ab9c3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/api/table_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Table functions
.. autofunction::
legate_dataframe.lib.join.join

.. autofunction::
legate_dataframe.lib.sort.sort


Related options/enums
---------------------
Expand All @@ -27,3 +30,12 @@ Related options/enums

.. autodata:: legate_dataframe.lib.join.null_equality
:no-value:

.. autodata:: legate_dataframe.lib.sort.Order

Column sort order, either ``ASCENDING`` or ``DESCENDING`` (from ``pylibcudf``).

.. autodata:: legate_dataframe.lib.sort.NullOrder

NULL sort order with respect to values, either ``FIRST`` or ``LAST``.
I.e. whether NULL is considered smaller or larger any possible value.

0 comments on commit 64ab9c3

Please sign in to comment.