Skip to content

Commit

Permalink
apacheGH-34017: [Python][FlightRPC][Doc] Fix read_chunk docstring f…
Browse files Browse the repository at this point in the history
…or FlightStreamReader and MetadataRecordBatchReader (apache#38641)

### Rationale for this change

The docs for `FlightStreamReader` and `MetadataRecordBatchReader` currently list an incorrect return type for the `read_chunk` method - see apache#34017. NB: this issue was partially addressed by apache#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: apache#34017

Authored-by: Nick Hughes <[email protected]>
Signed-off-by: David Li <[email protected]>
  • Loading branch information
nph authored and loicalleyne committed Nov 13, 2023
1 parent ed5b835 commit 1fd2ad4
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions python/pyarrow/_flight.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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
------
Expand Down

0 comments on commit 1fd2ad4

Please sign in to comment.