Skip to content
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.

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

Improve options docs #15888

Merged
merged 2 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions docs/cudf/source/cudf_pandas/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,5 @@ correct result. Data is automatically transferred from host to device
transfers.

When using `cudf.pandas`, cuDF's [pandas compatibility
mode](https://docs.rapids.ai/api/cudf/stable/api_docs/options/#available-options)
is automatically enabled, ensuring consistency with pandas-specific
semantics like default sort ordering.
mode](api.options) is automatically enabled, ensuring consistency with
pandas-specific semantics like default sort ordering.
13 changes: 13 additions & 0 deletions docs/cudf/source/user_guide/api_docs/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ Options and settings
cudf.describe_option
cudf.option_context

Display options are controlled by pandas
----------------------------------------

Options for display are inherited from pandas. This includes commonly accessed options such as:

- ``display.max_columns``
- ``display.max_info_rows``
- ``display.max_rows``
- ``display.max_seq_items``

For example, to show all rows of a DataFrame or Series in a Jupyter notebook, call ``pandas.set_option("display.max_rows", None)``.

See also the :ref:`full list of pandas display options <pandas:options.available>`.

Available options
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/cudf/source/user_guide/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ When no argument is provided,
all options are printed.
To set value to a option, use {py:func}`cudf.set_option`.

See the [API reference](api.options) for more details.
See the [options API reference](api.options) for descriptions of the available options.
Loading