apache / apache/arrow

[Python][Doc] Add import statement to `filters_to_expression` docstring example

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

Description

### Describe the enhancement requested

The docstring example for `pyarrow.parquet.filters_to_expression` calls the function without any import statement.

https://github.com/apache/arrow/blob/8c27898d36f45ece9b0d114b3d6c6a42d20bde7f/python/pyarrow/parquet/core.py#L149

The example should reflect how users would actually call the function:

```python
>>> import pyarrow.parquet as pq
>>> pq.filters_to_expression([('foo', '==', 'bar')])

```

### Component(s)

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.