You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "martin-g (via GitHub)" <gi...@apache.org> on 2026/09/17 05:35:46 UTC
[PR] chore(docs): Fix the documentation for TableProvider::scan()'s `limit` argument [datafusion]
martin-g opened a new pull request, #25397:
URL: https://github.com/apache/datafusion/pull/25397
## 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] chore(docs): Fix the documentation for TableProvider::scan()'s `limit` argument [datafusion]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #25397:
URL: https://github.com/apache/datafusion/pull/25397#issuecomment-5709698485
## [Codecov](https://app.codecov.io/gh/apache/datafusion/pull/25397?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 81.97%. Comparing base ([`0bef032`](https://app.codecov.io/gh/apache/datafusion/commit/0bef032a4a42a2d809c0090cc6703ca1788184a3?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`1c00085`](https://app.codecov.io/gh/apache/datafusion/commit/1c000857a08506cbd52807f781496d670153b6a6?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 1 commits behind head on main.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## main #25397 +/- ##
==========================================
- Coverage 81.97% 81.97% -0.01%
==========================================
Files 1137 1137
Lines 429901 429901
Branches 429901 429901
==========================================
- Hits 352424 352414 -10
- Misses 56428 56435 +7
- Partials 21049 21052 +3
```
</details>
[:umbrella: View full report in Codecov by Harness](https://app.codecov.io/gh/apache/datafusion/pull/25397?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] chore(docs): Fix the documentation for TableProvider::scan()'s `limit` argument [datafusion]
Posted by "2010YOUY01 (via GitHub)" <gi...@apache.org>.
2010YOUY01 merged PR #25397:
URL: https://github.com/apache/datafusion/pull/25397
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org