ARROW-15429: [Python] Address docstrings for ChunkedArray class, meth…

…ods, attributes and constructor This PR adds docstring examples to: - `pyarrow.ChunkedArray` class methods and attributes - `pyarrow.chunked_array` - `to_pandas` for `_PandasConvertible` Closes apache#12754 from AlenkaF/ARROW-15429 Lead-authored-by: Alenka Frim <[email protected]> Co-authored-by: Alenka Frim <[email protected]> Signed-off-by: Alessandro Molina <[email protected]>
davidhao3300 · Apr 7, 2022 · e5072bd · e5072bd
1 parent 77db0cf
commit e5072bd
Show file tree

Hide file tree

Showing 2 changed files with 694 additions and 4 deletions.
diff --git a/python/pyarrow/array.pxi b/python/pyarrow/array.pxi
@@ -768,6 +768,22 @@ cdef class _PandasConvertible(_Weakrefable):
         3     100      Centipede
         >>> isinstance(table.to_pandas(), pd.DataFrame)
         True
+
+        Convert a Chunked Array to pandas Series:
+
+        >>> import pyarrow as pa
+        >>> n_legs = pa.chunked_array([[2, 2, 4], [4, 5, 100]])
+        >>> n_legs.to_pandas()
+        0      2
+        1      2
+        2      4
+        3      4
+        4      5
+        5    100
+        dtype: int64
+        >>> import pandas as pd
+        >>> isinstance(n_legs.to_pandas(), pd.Series)
+        True
         """
         options = dict(
             pool=memory_pool,