From 8786193aade90aa817c21bbabcb854a421f36eee Mon Sep 17 00:00:00 2001 From: Simon Lin Date: Tue, 18 Jun 2024 23:23:48 +1000 Subject: [PATCH] add comments --- crates/polars-lazy/src/scan/file_list_reader.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/polars-lazy/src/scan/file_list_reader.rs b/crates/polars-lazy/src/scan/file_list_reader.rs index f76f57b813df..e31771e78334 100644 --- a/crates/polars-lazy/src/scan/file_list_reader.rs +++ b/crates/polars-lazy/src/scan/file_list_reader.rs @@ -12,6 +12,9 @@ use crate::prelude::*; pub type PathIterator = Box>>; +/// Recursively traverses directories and expands globs if `glob` is `true`. +/// Returns the expanded paths and the index at which to start parsing hive +/// partitions from the path. fn expand_paths( paths: &[PathBuf], #[allow(unused_variables)] cloud_options: Option<&CloudOptions>, @@ -237,7 +240,7 @@ pub trait LazyFileListReader: Clone { } /// Returns a list of paths after resolving globs and directories, as well as - /// the hive start index. + /// the string index at which to start parsing hive partitions. fn expand_paths(&self) -> PolarsResult<(Arc<[PathBuf]>, usize)> { expand_paths(self.paths(), self.cloud_options(), self.glob()) }