mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-04-21 18:23:35 +00:00
57 lines
1.7 KiB
Python
57 lines
1.7 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""
|
|
Custom documentation additions for compute functions.
|
|
"""
|
|
|
|
function_doc_additions = {}
|
|
|
|
function_doc_additions["filter"] = """
|
|
Examples
|
|
--------
|
|
>>> import pyarrow as pa
|
|
>>> arr = pa.array(["a", "b", "c", None, "e"])
|
|
>>> mask = pa.array([True, False, None, False, True])
|
|
>>> arr.filter(mask)
|
|
<pyarrow.lib.StringArray object at 0x7fa826df9200>
|
|
[
|
|
"a",
|
|
"e"
|
|
]
|
|
>>> arr.filter(mask, null_selection_behavior='emit_null')
|
|
<pyarrow.lib.StringArray object at 0x7fa826df9200>
|
|
[
|
|
"a",
|
|
null,
|
|
"e"
|
|
]
|
|
"""
|
|
|
|
function_doc_additions["mode"] = """
|
|
Examples
|
|
--------
|
|
>>> import pyarrow as pa
|
|
>>> import pyarrow.compute as pc
|
|
>>> arr = pa.array([1, 1, 2, 2, 3, 2, 2, 2])
|
|
>>> modes = pc.mode(arr, 2)
|
|
>>> modes[0]
|
|
<pyarrow.StructScalar: {'mode': 2, 'count': 5}>
|
|
>>> modes[1]
|
|
<pyarrow.StructScalar: {'mode': 1, 'count': 2}>
|
|
"""
|