You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Micah Kornfield (Jira)" <ji...@apache.org> on 2021/01/23 04:13:00 UTC
[jira] [Commented] (ARROW-11179) [Format] Make comments in fb files
friendly to rust doc
[ https://issues.apache.org/jira/browse/ARROW-11179?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17270543#comment-17270543 ]
Micah Kornfield commented on ARROW-11179:
-----------------------------------------
It is OK with me if you want to open a PR. I don't we rely on the formatting for other languages but I could be wrong. [~uwe] or [~apitrou] might know better.
> [Format] Make comments in fb files friendly to rust doc
> -------------------------------------------------------
>
> Key: ARROW-11179
> URL: https://issues.apache.org/jira/browse/ARROW-11179
> Project: Apache Arrow
> Issue Type: Improvement
> Reporter: Qingyou Meng
> Priority: Trivial
> Attachments: format-0ed34c83.patch
>
>
> Currently, comments in flatbuffer files are directly copied to rust and c++ source codes.
> That's great but there are some problems with cargo doc:
> * array element abc[1] or link label [smith2017knl] causes `broken intra doc links` warning
> * example code/figure blocks are flatten into one line, see example [arrow 2.0.0 doc|https://docs.rs/arrow/2.0.0/arrow/ipc/gen/SparseTensor/struct.SparseTensorIndexCSF.html#method.indptrType]
> After flatc generating, those ipc files have to be updated manually to fix the above problems.
> So I'm suggesting update flatbuffer comments to address this problem.
> * Escape inline code with ` and `
> * Escape text block with ```text and ```
> * change {color:#00875a}[smith2017knl]:{color} [http://shaden.io/pub-files/smith2017knl.pdf] to {color:#403294}[smith2017knl]({color}{color:#403294}[http://shaden.io/pub-files/smith2017knl.pdf]){color}
> {color:#172b4d}The attachment file *format-0ed34c83.patch*{color} is created with git command
> {code:java}
> git diff 0ed34c83 -p format > format-0ed34c83.patch{code}
> where *0ed34c83* is this commit:
> {noformat}
> 0ed34c83c ARROW-9400: [Python] Do not depend on conda-forge static libraries in Windows wheel builds{noformat}
> [~emkornfield] may I create a pull request for this?
--
This message was sent by Atlassian Jira
(v8.3.4#803005)