-
Notifications
You must be signed in to change notification settings - Fork 4k
ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC #10512
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC #10512
Conversation
kou
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
docs/source/format/Columnar.rst
Outdated
| streaming format) plus memory offsets and sizes for each of the data | ||
| blocks in the file. This enables random access any record batch in the | ||
| file. See `File.fbs`_ for the precise details of the file footer. | ||
| We define a "file format" supporting random access that is built with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we are at it, can we replace "built with" with something less weird / less confusing? Perhaps "built upon" or "built on top of" or "is an extension of" (or...)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went with "is an extension of"
docs/source/format/Columnar.rst
Outdated
| blocks in the file. This enables random access any record batch in the | ||
| file. See `File.fbs`_ for the precise details of the file footer. | ||
| We define a "file format" supporting random access that is built with | ||
| the stream format. We recommend the ".arrow" extension for files. The |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"for such files" or "for IPC files"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved the sentence down to the end and changed it to We recommend the ".arrow" extension for files created with this format.
pitrou
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, thank you @westonpace
See JIRA Closes apache#10512 from westonpace/feature/ARROW-13036--doc-mention-recommended-file-extension-s-for-ar Authored-by: Weston Pace <weston.pace@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
See JIRA