apache / apache/arrow

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

Open
#48,644 0 comments 0 reactions 1 assignee Claimed by @zhengruifeng View on GitHub
Component: Documentation Component: Python Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

### 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

```py
In [1]: import pyarrow as pa

In [2]: pa.ipc.read_schema
Out[2]:

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:
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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.