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

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


The following commit(s) were added to refs/heads/master by this push:
     new 520feec  ARROW-5309: [Python] clarify that Schema.append returns new 
object
520feec is described below

commit 520feeccafc6b3b2f19aee10f31253dc6504b8b9
Author: Joris Van den Bossche <jorisvandenboss...@gmail.com>
AuthorDate: Tue Jun 18 12:36:35 2019 -0400

    ARROW-5309: [Python] clarify that Schema.append returns new object
    
    https://issues.apache.org/jira/browse/ARROW-5309. I didn't find any other 
append method in the Python API (except for Table.append_column, which is 
already clear about returning a new table).
    
    Author: Joris Van den Bossche <jorisvandenboss...@gmail.com>
    
    Closes #4599 from jorisvandenbossche/ARROW-5309-append-docs and squashes 
the following commits:
    
    0c82dbc54 <Joris Van den Bossche> typo
    78ea95044 <Joris Van den Bossche> ARROW-5309:  clarify that Schema.append 
returns new object
---
 python/pyarrow/types.pxi | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/python/pyarrow/types.pxi b/python/pyarrow/types.pxi
index 1f0db4c..b456e01 100644
--- a/python/pyarrow/types.pxi
+++ b/python/pyarrow/types.pxi
@@ -926,6 +926,9 @@ cdef class Schema:
         """
         Append a field at the end of the schema.
 
+        In contrast to Python's ``list.append()`` it does return a new
+        object, leaving the original Schema unmodified.
+
         Parameters
         ----------
         field: Field
@@ -933,6 +936,7 @@ cdef class Schema:
         Returns
         -------
         schema: Schema
+            New object with appended field.
         """
         return self.insert(self.schema.num_fields(), field)
 

Reply via email to