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

• Type: Test
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 4.0.0
• Component/s: Rust - DataFusion
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/27846
• Assignee: Ruan Pearce-Authers
• Reporter: Ruan Pearce-Authers
• Created: 18/Mar/21 13:01
• Updated: 11/Jan/23 08:23
• Resolved: 19/Mar/21 10:54

Description

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

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.

Issue Links

• links to: GitHub Pull Request #9749
• links to: GitHub Pull Request #9754