Skip to content

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

Description

@wence-

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    cudf-polarsIssues specific to cudf-polarsfeature requestNew feature or request

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions