You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/01/23 08:55:10 UTC
[GitHub] [arrow] mqy opened a new pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
mqy opened a new pull request #9299:
URL: https://github.com/apache/arrow/pull/9299
### Problem
Currently, comments in FB files are directly copied to rust and c++ source codes. That's great but `rust` suffers from the generated codes, for example:
- array element `abc[1]` or link label `[smith2017knl]` causes `broken intra doc links` warning
- example code/figure blocks are flatten into one line, see [arrow 2.0.0 doc](https://docs.rs/arrow/2.0.0/arrow/ipc/gen/SparseTensor/struct.SparseTensorIndexCSF.html#method.indptrType)
The above problems may lead to failures or warnings when run `rust test --doc` or `rust doc`.
So the generated `.rs` files have to be manually modified to fix the above problems.
### This PR
This PR changed three FB files by formatting some comments to make them friendly to rust.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
pitrou commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-766875433
No concern from me. @wesm @xhochy @emkornfield What do you think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] mqy commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
mqy commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-767312376
@pitrou @emkornfield thanks!
> Looks OK to me as well, is it possible to generate one off docs with this change to confirm the figures look OK?
As of `rust`, files `rust/arrow/src/ipc/gen/*.rs` on remote `master` branch had been generated with this patch. I've test locally with `cargo test --doc` and `cargo doc` -- no errors/warnings and the figures looks good like this:
```
0 1
/ \ |
0 1 1
/ / \ |
0 0 1 1
/| /| | /| |
1 2 0 2 0 0 1 2
```
For `cpp` or other languages that copy comments into generated codes, perhaps it's better to verify that this patch is sound.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] mqy edited a comment on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
mqy edited a comment on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-767312376
@pitrou @emkornfield thanks!
> Looks OK to me as well, is it possible to generate one off docs with this change to confirm the figures look OK?
As of `rust`, files `rust/arrow/src/ipc/gen/*.rs` on remote `master` branch had been generated with this patch. Based on the regenerated files, I had run `cargo test --doc` and `cargo doc` locally -- no errors/warnings and the figures look good like this:
```
0 1
/ \ |
0 1 1
/ / \ |
0 0 1 1
/| /| | /| |
1 2 0 2 0 0 1 2
```
For `cpp` or other languages that copy comments into generated codes, perhaps it's better to verify that this patch is sound.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] mqy edited a comment on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
mqy edited a comment on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-767312376
@pitrou @emkornfield thanks!
> Looks OK to me as well, is it possible to generate one off docs with this change to confirm the figures look OK?
As of `rust`, files `rust/arrow/src/ipc/gen/*.rs` on remote `master` branch had been generated with this patch. I've test locally with `cargo test --doc` and `cargo doc` -- no errors/warnings and the figures look good like this:
```
0 1
/ \ |
0 1 1
/ / \ |
0 0 1 1
/| /| | /| |
1 2 0 2 0 0 1 2
```
For `cpp` or other languages that copy comments into generated codes, perhaps it's better to verify that this patch is sound.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
pitrou commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-766875433
No concern from me. @wesm @xhochy @emkornfield What do you think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] emkornfield commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
emkornfield commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-767289020
Looks OK to me as well, is it possible to generate one off docs with this change to confirm the figures look OK?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] emkornfield commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
emkornfield commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-770157847
+1.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] emkornfield closed pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
emkornfield closed pull request #9299:
URL: https://github.com/apache/arrow/pull/9299
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #9299: ARROW-11179: [Format] Make FB comments friendly to rust
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #9299:
URL: https://github.com/apache/arrow/pull/9299#issuecomment-765891515
https://issues.apache.org/jira/browse/ARROW-11179
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org