GH-34017: [Python][FlightRPC][Doc] Fix read_chunk docstring for Fli…

…ghtStreamReader and MetadataRecordBatchReader (#38641) ### Rationale for this change The docs for `FlightStreamReader` and `MetadataRecordBatchReader` currently list an incorrect return type for the `read_chunk` method - see #34017. NB: this issue was partially addressed by #35583. ### What changes are included in this PR? Simple docstring update for `read_chunk`. ### Are these changes tested? No (v minor docstring only change) ### Are there any user-facing changes? Yes * Closes: #34017 Authored-by: Nick Hughes <[email protected]> Signed-off-by: David Li <[email protected]>
apache · Nov 9, 2023 · 80503a6 · 80503a6
1 parent 9569be8
commit 80503a6
Showing 1 changed file with 1 addition and 4 deletions.
diff --git a/python/pyarrow/_flight.pyx b/python/pyarrow/_flight.pyx
@@ -1014,11 +1014,8 @@ cdef class _MetadataRecordBatchReader(_Weakrefable, _ReadPandasMixin):
 
         Returns
         -------
-        data : FlightStreamChunk
+        chunk : FlightStreamChunk
             The next FlightStreamChunk in the stream.
-        app_metadata : Buffer or None
-            Application-specific metadata for the batch as defined by
-            Flight.
 
         Raises
         ------