jorisvandenbossche commented on a change in pull request #12627:
URL: https://github.com/apache/arrow/pull/12627#discussion_r829146409
##########
File path: docs/source/python/data.rst
##########
@@ -512,3 +512,23 @@ a new schema and cast the data to this schema:
Metadata key and value pair are ``std::string`` objects in the C++
implementation
and so they are bytes objects (``b'...'``) in Python.
+
+Record Batch Readers
+--------------------
+
+Many functions in PyArrow either return or take as an argument a
:class:`RecordBatchReader`.
+It can be used like any iterable of record batches, but also provides their
common
+schema without having to get any of the batches.
+
+.. ipython:: python
Review comment:
Since the rest of the file already uses it, I would maybe keep using the
ipython block (within this file) for consistency? (until we actually change
this)
Although I am also fine to already start using doctest syntax wherever
possible.
--
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]
