Skip to content

[PYTHON][DOC] Some PIC functions are not documented in API reference #48644

@zhengruifeng

Description

@zhengruifeng

Describe the enhancement requested

https://arrow.apache.org/docs/dev/python/api/ipc.html

For example, pa.ipc.read is missing in the API reference

In [1]: import pyarrow as pa

In [2]: pa.ipc.read_schema
Out[2]: <cyfunction read_schema at 0x1053de080>

In [3]: pa.ipc.read_schema?
Signature:      pa.ipc.read_schema(obj, dictionary_memo=None)
Call signature: pa.ipc.read_schema(*args, **kwargs)
Type:           cython_function_or_method
String form:    <cyfunction read_schema at 0x1053de080>
Docstring:
read_schema(obj, DictionaryMemo dictionary_memo=None)

Read Schema from message or buffer

Parameters
----------
obj : buffer or Message
dictionary_memo : DictionaryMemo, optional
    Needed to be able to reconstruct dictionary-encoded fields
    with read_record_batch

Returns
-------
schema : Schema

Component(s)

Python, Documentation

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions