NVIDIA / NVIDIA/cudf

[DOC] Document cuDF options

Open
#14,501 0 comments 0 reactions 0 assignees View on GitHub
0 - Backlog doc Python
Dominant language
C++
Stars
9.8k
Forks
1.1k
Avg merge
3d 6m
Merged PRs (30d)
278

Description

## Report needed documentation

**Report needed documentation**
Currently options are simply documented by embedding the output of `cudf.describe_option` directly in our docs: https://docs.rapids.ai/api/cudf/stable/user_guide/api_docs/options/#api-options. This approach is not very informative.

**Describe the documentation you'd like**
We should instead document individual options separately. [The corresponding pandas page](https://pandas.pydata.org/docs/user_guide/options.html) does not document all options in detail, but it does include [extended information on the frequently used options](https://pandas.pydata.org/docs/user_guide/options.html#frequently-used-options). We should mimic that approach and focus on documenting the most important options.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.