You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@arrow.apache.org by "Ruan Pearce-Authers (Jira)" <ji...@apache.org> on 2021/03/18 13:02:00 UTC

[jira] [Created] (ARROW-12015) [Rust] [DataFusion] Integrate doc-comment crate to ensure readme examples remain valid

Ruan Pearce-Authers created ARROW-12015:
-------------------------------------------

             Summary: [Rust] [DataFusion] Integrate doc-comment crate to ensure readme examples remain valid
                 Key: ARROW-12015
                 URL: https://issues.apache.org/jira/browse/ARROW-12015
             Project: Apache Arrow
          Issue Type: Test
          Components: Rust - DataFusion
            Reporter: Ruan Pearce-Authers
            Assignee: Ruan Pearce-Authers


As discussed at: [https://github.com/apache/arrow/pull/9710#discussion_r596404956]

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



--
This message was sent by Atlassian Jira
(v8.3.4#803005)