[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #33698: GH-31507: [Python] Address docstrings in Streams and File Access (Stream Classes)

[GitBox]

jorisvandenbossche commented on code in PR #33698:
URL: https://github.com/apache/arrow/pull/33698#discussion_r1072084816


##########
python/pyarrow/io.pxi:
##########
@@ -1368,6 +1456,26 @@ cdef class BufferReader(NativeFile):
     Parameters
     ----------
     obj : Python bytes or pyarrow.Buffer
+
+    Examples
+    --------
+
+    >>> import pyarrow as pa
+    >>> data = b'reader data'
+    >>> f = pa.BufferReader(data)

Review Comment:
   We should maybe also reference `pa.input_stream()` as the (preferred?) way 
to create BufferReader objects?



-- 
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-unsubscr...@arrow.apache.org

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