From 80503a6a1a024bbac32213b597a2b0e46bfcf390 Mon Sep 17 00:00:00 2001 From: Nick Hughes Date: Thu, 9 Nov 2023 07:39:22 -0800 Subject: [PATCH] GH-34017: [Python][FlightRPC][Doc] Fix `read_chunk` docstring for FlightStreamReader 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 Signed-off-by: David Li --- python/pyarrow/_flight.pyx | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/python/pyarrow/_flight.pyx b/python/pyarrow/_flight.pyx index 79aa24e4ce8e3..8fe9465a13d9c 100644 --- 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 ------