[GitHub] [arrow] wjones127 commented on a change in pull request #12627: ARROW-15860: [Python] Document RecordBatchReader

[GitBox <gi...@apache.org>]

wjones127 commented on a change in pull request #12627:
URL: https://github.com/apache/arrow/pull/12627#discussion_r829327809



##########
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:
       I see doctest extension is included, but I see no usage of doctest directive yet.
   
   I agree with Antoine that I don't want this contribute to tech debt, but it seems if I use a plain code block or ipython either way we will want to convert to a doctest in the future. So inclined to leave as is, but happy to help make a PR soon for moving to doctest.




-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org