Skip to content

[Rust] [DataFusion] Integrate doc-comment crate to ensure readme examples remain valid #27846

@asfimport

Description

@asfimport

As discussed at: #9710 (comment)

We can use the doc-comment crate to include snippets of Rust code from the readme in our doctest runs, ensuring that our documentation doesn't drift from reality as API changes are made.

Reporter: Ruan Pearce-Authers / @returnString
Assignee: Ruan Pearce-Authers / @returnString

PRs and other links:

Note: This issue was originally created as ARROW-12015. Please see the migration documentation for further details.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions