NVIDIA / NVIDIA/cudf

[FEA] Generate docs description of cudf-polars engine options from code

Open
#23,949 0 comments 1 reaction 0 assignees View on GitHub
cudf-polars feature request
Dominant language
C++
Stars
9.8k
Forks
1.1k
Avg merge
3d 6m
Merged PRs (30d)
278

Description

**Is your feature request related to a problem? Please describe.**

cudf-polars has many options for the streaming engine, enumerated in cudf_polars/streaming/options.py (or similar). These all come with defaults and descriptions.

These defaults and descriptions are replicated at least twice: once in the code, and then again in a table in the documentation.

This is bad, because the two can go out of sync with one-another.

**Describe the solution you'd like**

We should generate the documentation table from the canonical options file.

**Describe alternatives you've considered**

Maintain both by hand and hope reviews catch mismatches.

Contributor guide

Open the contributing guide

Research direction

Start with cudf_polars/streaming/options.py, or the corresponding options module, and locate the documentation table that repeats its streaming engine defaults and descriptions. Trace how the documentation is built, then make the table derive from the canonical options definitions and verify that generated entries match the code.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.