Skip to content

chore(docs): Fix the documentation for TableProvider::scan()'s limit argument - #25397

Open
martin-g wants to merge 1 commit into
apache:mainfrom
martin-g:fix-TableProvider-limit-docs
Open

martin-g wants to merge 1 commit into
apache:mainfrom
martin-g:fix-TableProvider-limit-docs

Conversation

@martin-g

Copy link
Copy Markdown
Member

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.

…` argument

In SQL semantics the `LIMIT` tells the maximum number of rows to return.
Not the minimum.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.97%. Comparing base (0bef032) to head (1c00085).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            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     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants