Skip to content

Commit 0dd7172

Browse files
committed
fix
1 parent de4e3b4 commit 0dd7172

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

python/pyarrow/_compute_docstrings.py

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,60 @@
5454
>>> modes[1]
5555
<pyarrow.StructScalar: [('mode', 1), ('count', 2)]>
5656
"""
57+
58+
function_doc_additions["min"] = """
59+
Examples
60+
--------
61+
>>> import pyarrow as pa
62+
>>> import pyarrow.compute as pc
63+
>>> arr1 = pa.array([1, 1, 2, 2, 3, 2, 2, 2])
64+
>>> pc.min(arr1)
65+
<pyarrow.Int64Scalar: 1>
66+
>>> arr2 = pa.array([1.0, None, 2.0, 3.0])
67+
>>> pc.min(arr2)
68+
<pyarrow.DoubleScalar: 1.0>
69+
>>> arr3 = pa.array([1.0, None, float("nan"), 3.0])
70+
>>> pc.min(arr3)
71+
<pyarrow.DoubleScalar: 1.0>
72+
>>> arr4 = pa.array(["z", None, "y", "x"])
73+
>>> pc.min(arr4)
74+
<pyarrow.StringScalar: 'x'>
75+
"""
76+
77+
function_doc_additions["max"] = """
78+
Examples
79+
--------
80+
>>> import pyarrow as pa
81+
>>> import pyarrow.compute as pc
82+
>>> arr1 = pa.array([1, 1, 2, 2, 3, 2, 2, 2])
83+
>>> pc.max(arr1)
84+
<pyarrow.Int64Scalar: 3>
85+
>>> arr2 = pa.array([1.0, None, 2.0, 3.0])
86+
>>> pc.max(arr2)
87+
<pyarrow.DoubleScalar: 3.0>
88+
>>> arr3 = pa.array([1.0, None, float("nan"), 3.0])
89+
>>> pc.max(arr3)
90+
<pyarrow.DoubleScalar: 3.0>
91+
>>> arr4 = pa.array(["z", None, "y", "x"])
92+
>>> pc.max(arr4)
93+
<pyarrow.StringScalar: 'z'>
94+
"""
95+
96+
function_doc_additions["min_max"] = """
97+
Examples
98+
--------
99+
>>> import pyarrow as pa
100+
>>> import pyarrow.compute as pc
101+
>>> arr1 = pa.array([1, 1, 2, 2, 3, 2, 2, 2])
102+
>>> pc.min_max(arr1)
103+
<pyarrow.StructScalar: [('min', 1), ('max', 3)]>
104+
>>> arr2 = pa.array([1.0, None, 2.0, 3.0])
105+
>>> pc.min_max(arr2)
106+
<pyarrow.StructScalar: [('min', 1.0), ('max', 3.0)]>
107+
>>> arr3 = pa.array([1.0, None, float("nan"), 3.0])
108+
>>> pc.min_max(arr3)
109+
<pyarrow.StructScalar: [('min', 1.0), ('max', 3.0)]>
110+
>>> arr4 = pa.array(["z", None, "y", "x"])
111+
>>> pc.min_max(arr4)
112+
<pyarrow.StructScalar: [('min', 'x'), ('max', 'z')]>
113+
"""

0 commit comments

Comments
 (0)