Skip to content

Commit f028365

Browse files
docs: fix scan_metadata docs (delta-io#1450)
## What changes are proposed in this pull request? fix docs that mentioned a method that doesn't exist. ## How was this change tested? docs only
1 parent 442efe2 commit f028365

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

ffi/src/scan.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ pub unsafe extern "C" fn visit_string_map(
368368
/// Transformation expressions that need to be applied to each row `i` in ScanMetadata. You can use
369369
/// [`get_transform_for_row`] to get the transform for a particular row. If that returns an
370370
/// associated expression, it _must_ be applied to the data read from the file specified by the
371-
/// row. The resultant schema for this expression is guaranteed to be `Scan.schema()`. If
371+
/// row. The resultant schema for this expression is guaranteed to be [`scan_logical_schema()`]. If
372372
/// `get_transform_for_row` returns `NULL` no expression need be applied and the data read from disk
373373
/// is already in the correct logical state.
374374
///

kernel/src/scan/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -384,10 +384,10 @@ impl Scan {
384384
/// - `Vec<Option<Expression>>`: Transformation expressions that need to be applied. For each
385385
/// row at index `i` in the above data, if an expression exists at index `i` in the `Vec`,
386386
/// the associated expression _must_ be applied to the data read from the file specified by
387-
/// the row. The resultant schema for this expression is guaranteed to be `Scan.schema()`. If
388-
/// the item at index `i` in this `Vec` is `None`, or if the `Vec` contains fewer than `i`
389-
/// elements, no expression need be applied and the data read from disk is already in the
390-
/// correct logical state.
387+
/// the row. The resultant schema for this expression is guaranteed to be
388+
/// [`Self::logical_schema()`]. If the item at index `i` in this `Vec` is `None`, or if the
389+
/// `Vec` contains fewer than `i` elements, no expression need be applied and the data read
390+
/// from disk is already in the correct logical state.
391391
pub fn scan_metadata(
392392
&self,
393393
engine: &dyn Engine,

0 commit comments

Comments
 (0)