[jira] [Commented] (ARROW-4245) [Rust] Add Rustdoc header to each source file
[ https://issues.apache.org/jira/browse/ARROW-4245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16748153#comment-16748153 ] Paul Kernfeld commented on ARROW-4245: -- Okay, thanks for the advice! I have just created a PR, so please let me know how it looks. > [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 > Labels: pull-request-available > Fix For: 0.13.0 > > Time Spent: 10m > Remaining Estimate: 0h > > 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)
[jira] [Commented] (ARROW-4245) [Rust] Add Rustdoc header to each source file
[ https://issues.apache.org/jira/browse/ARROW-4245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16747153#comment-16747153 ] Andy Grove commented on ARROW-4245: --- [~paulkernfeld] This is exactly what I had in mind :) I look forward to seeing the PR > [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)
[jira] [Commented] (ARROW-4245) [Rust] Add Rustdoc header to each source file
[
https://issues.apache.org/jira/browse/ARROW-4245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16747140#comment-16747140
]
Uwe L. Korn commented on ARROW-4245:
[~paulkernfeld] To get better feedback, I recommend to already open a PR on
GitHub and prefixing it with {{WIP}} (work in progress). This gives us the
better review tools while everyone is aware that the work is not done yet.
> [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)
[jira] [Commented] (ARROW-4245) [Rust] Add Rustdoc header to each source file
[ https://issues.apache.org/jira/browse/ARROW-4245?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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)
