pitrou commented on code in PR #49947:
URL: https://github.com/apache/arrow/pull/49947#discussion_r3217064222
##########
docs/source/format/Columnar.rst:
##########
@@ -1333,22 +1334,21 @@ The flattened version of this is: ::
For the buffers produced, we would have the following (refer to the
table above): ::
- buffer 0: field 0 validity
- buffer 1: field 1 validity
- buffer 2: field 1 values
- buffer 3: field 2 validity
- buffer 4: field 2 offsets
- buffer 5: field 3 validity
- buffer 6: field 3 values
- buffer 7: field 4 validity
- buffer 8: field 4 values
- buffer 9: field 5 validity
- buffer 10: field 5 offsets
- buffer 11: field 5 data
-
-The ``Buffer`` Flatbuffers value describes the location and size of a
-piece of memory. Generally these are interpreted relative to the
-**encapsulated message format** defined below.
+ buffer 0: field 0 ('col1') validity
+ buffer 1: field 1 ('col1.a') validity
+ buffer 2: field 1 ('col1.a') values
+ buffer 3: field 2 ('col1.b') validity
+ buffer 4: field 2 ('col1.b') offsets
+ buffer 5: field 3 ('col1.b.item') validity
+ buffer 6: field 3 ('col1.b.item') values
+ buffer 7: field 4 ('col1.c') validity
+ buffer 8: field 4 ('col1.c') values
+ buffer 9: field 5 ('col2') validity
+ buffer 10: field 5 ('col2') offsets
+ buffer 11: field 5 ('col2') data
+
+The ``Buffer`` Flatbuffers value describes the location and size of a buffer's
+data, relatively to the start of the RecordBatch message's body.
Review Comment:
Hmm, the question is then whether this section of the doc describes the IPC
protocol in a narrow sense, or whether it applies to any variation over it such
as the Dissociated IPC protocol.
For readability I think it's better if it describes the concrete IPC
protocol as commonly implemented. 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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
