apache / apache/arrow

Improve ScannerBuilder documentation in regard to $Filter()

Open
#47,845 1 comment 0 reactions 0 assignees 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

Currently documentation of Scanner, as may be seen on [arrow.html#Scanner](https://cran.r-project.org/web/packages/arrow/refman/arrow.html#Scanner), feels very incomplete.

It is not clear how to for example filter rows to a fixed list of values, normally using `column %in% values`. One AI says to use `$in_set`, another says to use `$InSet`, none of those seems to work or be documented anywhere. Not sure if it is supported at all.
Other operators, like `! columns %in% values`, could also be added to documentation.
In general, many more examples would be useful.
How to combine two filters, can we call them one after another, or they have to be defined in a single `$Filter()` call?
How to combine with `&` and how to combine with `|`, if calling one after another.

### Component(s)

Documentation

Contributor guide

Open the contributing guide

Research direction

Start with the Scanner documentation linked at arrow.html#Scanner and the $Filter() API mentioned in the issue. Verify the supported syntax for membership, negation, and combining filters, then document those cases with examples; done when the ScannerBuilder documentation answers these usage questions clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.