You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2023/11/09 15:39:30 UTC

(arrow) branch main updated: GH-34017: [Python][FlightRPC][Doc] Fix `read_chunk` docstring for FlightStreamReader and MetadataRecordBatchReader (#38641)

This is an automated email from the ASF dual-hosted git repository.

lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/main by this push:
     new 80503a6a1a GH-34017: [Python][FlightRPC][Doc] Fix `read_chunk` docstring for FlightStreamReader and MetadataRecordBatchReader (#38641)
80503a6a1a is described below

commit 80503a6a1a024bbac32213b597a2b0e46bfcf390
Author: Nick Hughes <ni...@intervaliq.com>
AuthorDate: Thu Nov 9 07:39:22 2023 -0800

    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 <ni...@intervaliq.com>
    Signed-off-by: David Li <li...@gmail.com>
---
 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 79aa24e4ce..8fe9465a13 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
         ------