Commit e5469e1
authored
chore(docs): Fix the documentation for TableProvider::scan()'s
## Which issue does this PR close?
Closes N/A.
## Rationale for this change
https://docs.rs/datafusion/latest/datafusion/catalog/trait.TableProvider.html#limit
says
```
If limit is specified, the scan must produce at least this many rows, though it may return more
```
In SQL semantics the `LIMIT` tells the maximum number of rows to return.
Not the minimum.
## What changes are included in this PR?
Fixed the documentation for `TableProvider::scan()`'s `limit` argument
to match the similar documentation at
https://docs.rs/datafusion/latest/datafusion/catalog/struct.ScanArgs.html#method.with_limit
## What is the testing strategy for this PR?
Build the docs and verify that the documentation is correct.
## Are there any user-facing changes?
No.limit argument (#25397)1 parent b300cea commit e5469e1
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
153 | | - | |
154 | | - | |
| 153 | + | |
| 154 | + | |
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
| |||
0 commit comments