Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-11179

[Format] Make comments in fb files friendly to rust doc

    XMLWordPrintableJSON

    Details

      Description

      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

      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.

      The attachment file format-0ed34c83.patch is created with git command

      git diff 0ed34c83 -p format > format-0ed34c83.patch

      where 0ed34c83 is this commit: 

      0ed34c83c ARROW-9400: [Python] Do not depend on conda-forge static libraries in Windows wheel builds

      Micah Kornfield may I create a pull request for this?

        Attachments

        1. format-0ed34c83.patch
          8 kB
          Qingyou Meng

          Issue Links

            Activity

              People

              • Assignee:
                mqy Qingyou Meng
                Reporter:
                mqy Qingyou Meng
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 1h 40m
                  1h 40m