[
https://issues.apache.org/jira/browse/ARROW-12015?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ruan Pearce-Authers updated ARROW-12015:
----------------------------------------
Description:
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 from the readme in our doctest runs, ensuring
that our documentation doesn't drift from reality as API changes are made.
was:
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.
> [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
> Priority: Minor
> Original Estimate: 2h
> Remaining Estimate: 2h
>
> 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 from 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)
