Minor: Improve docs for arrow-ipc, remove clippy ignore #3421
Conversation
| /// | ||
| /// // Error of dictionary ids are replaced. | ||
| /// let error_on_replacement = true; | ||
| /// let options = IpcWriteOptions::default(); |
There was a problem hiding this comment.
This interface is somewhat unfortunate (like there is no state on IpcDataGenerator and the state is passed in via DictionaryTracker).
While implementing #3389 I hope to provide something that handles all the encoding state so this interface will remain low level
There was a problem hiding this comment.
I wonder if the state was at one point on IpcDataGenerator and it got factored out for some reason 🤔
| /// | ||
| /// // Error of dictionary ids are replaced. | ||
| /// let error_on_replacement = true; | ||
| /// let options = IpcWriteOptions::default(); |
There was a problem hiding this comment.
I wonder if the state was at one point on IpcDataGenerator and it got factored out for some reason 🤔
arrow-ipc/src/lib.rs
Outdated
|
|
||
| // TODO: (vcq): Protobuf codegen is not generating Debug impls. | ||
| #![allow(missing_debug_implementations)] | ||
| //! Support for the [Arrow IPC Format](https://arrow.apache.org/docs/format/IPC.html) |
There was a problem hiding this comment.
Actually this page was moved. Maybe we can point to https://arrow.apache.org/docs/format/Columnar.html#format-columnar, or https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc specifically?
|
Benchmark runs are scheduled for baseline = ec43d6f and contender = 2408bb2. 2408bb2 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Which issue does this PR close?
N/A
Rationale for this change
A deprecation warning says to use
IpcDataGeneratorbut then there are no docstrings for that generatorWhat changes are included in this PR?
IpcDataGeneratorAre there any user-facing changes?
Better docs