Skip to content

Commit e5469e1

Browse files
authored
chore(docs): Fix the documentation for TableProvider::scan()'s limit argument (#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.
1 parent b300cea commit e5469e1

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎datafusion/session/src/table.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ pub trait TableProvider: Any + Debug + Sync + Send {
150150
///
151151
/// # Limit
152152
///
153-
/// If `limit` is specified, the scan must produce *at least* this many
154-
/// rows, though it may return more. Like Projection Pushdown and Filter
153+
/// If `limit` is specified, the scan must produce *at most* this many
154+
/// rows, though it may return less. Like Projection Pushdown and Filter
155155
/// Pushdown, DataFusion pushes `LIMIT`s as far down in the plan as
156156
/// possible. This is called "Limit Pushdown", and some sources can use the
157157
/// information to improve performance.

0 commit comments

Comments
 (0)