Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Licensed to the Apache Software Foundation (ASF) under one
2# or more contributor license agreements. See the NOTICE file
3# distributed with this work for additional information
4# regarding copyright ownership. The ASF licenses this file
5# to you under the Apache License, Version 2.0 (the
6# "License"); you may not use this file except in compliance
7# with the License. You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing,
12# software distributed under the License is distributed on an
13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14# KIND, either express or implied. See the License for the
15# specific language governing permissions and limitations
16# under the License.
18"""
19Custom documentation additions for compute functions.
20"""
22function_doc_additions = {}
24function_doc_additions["filter"] = """
25 Examples
26 --------
27 >>> import pyarrow as pa
28 >>> arr = pa.array(["a", "b", "c", None, "e"])
29 >>> mask = pa.array([True, False, None, False, True])
30 >>> arr.filter(mask)
31 <pyarrow.lib.StringArray object at ...>
32 [
33 "a",
34 "e"
35 ]
36 >>> arr.filter(mask, null_selection_behavior='emit_null')
37 <pyarrow.lib.StringArray object at ...>
38 [
39 "a",
40 null,
41 "e"
42 ]
43 """
45function_doc_additions["mode"] = """
46 Examples
47 --------
48 >>> import pyarrow as pa
49 >>> import pyarrow.compute as pc
50 >>> arr = pa.array([1, 1, 2, 2, 3, 2, 2, 2])
51 >>> modes = pc.mode(arr, 2)
52 >>> modes[0]
53 <pyarrow.StructScalar: [('mode', 2), ('count', 5)]>
54 >>> modes[1]
55 <pyarrow.StructScalar: [('mode', 1), ('count', 2)]>
56 """