[
https://issues.apache.org/jira/browse/ARROW-4245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16747134#comment-16747134
]
Paul Kernfeld commented on ARROW-4245:
--------------------------------------
I'm interested in trying to do this. Could someone take a look at [these
example docs I
wrote|https://github.com/apache/arrow/compare/master...paulkernfeld:arrow-4245-add-rustdoc-headers]
to see if I'm going in the right direction? If they look good, I'm happy to
add more. I deliberately added a lot of examples in the docs because I find
that I'm personally a lot more likely to engage with a project if it has lots
of examples.
> [Rust] Add Rustdoc header to each source file
> ---------------------------------------------
>
> Key: ARROW-4245
> URL: https://issues.apache.org/jira/browse/ARROW-4245
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Rust
> Reporter: Andy Grove
> Priority: Minor
> Fix For: 0.13.0
>
>
> Each source file should contain a rustdoc header giving a summary of the
> contents of the file. This will make the documentation hosted on docs.rs much
> more useful.
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
