Apache DataFusion SQL Query Engine
chore: Format examples in doc strings - catalog listing (#18335)
Yu-Chuan Hung606dfd236ca0
diff --git a/datafusion/catalog-listing/src/config.rs b/datafusion/catalog-listing/src/config.rsindex 90f44de4fd..3370d2ea75 100644--- a/datafusion/catalog-listing/src/config.rs+++ b/datafusion/catalog-listing/src/config.rs@@ -53,7 +53,6 @@ pub enum SchemaSource {////// If not specified, a [`datafusion_datasource::schema_adapter::DefaultSchemaAdapterFactory`]/// will be used, which handles basic schema compatibility cases.-///#[derive(Debug, Clone, Default)]pub struct ListingTableConfig {/// Paths on the `ObjectStore` for creating [`crate::ListingTable`].@@ -160,8 +159,8 @@ impl ListingTableConfig {/// .with_file_extension(".parquet")/// .with_collect_stat(true);///- /// let config = ListingTableConfig::new(table_paths)- /// .with_listing_options(options); // Configure file format and options+ /// let config = ListingTableConfig::new(table_paths).with_listing_options(options);+ /// // Configure file format and options/// ```pub fn with_listing_options(self, listing_options: ListingOptions) -> Self {// Note: This method properly sets options, but be aware that downstreamdiff --git a/datafusion/catalog-listing/src/options.rs b/datafusion/catalog-listing/src/options.rsindex 3cbf3573e9..7da8005f90 100644--- a/datafusion/catalog-listing/src/options.rs+++ b/datafusion/catalog-listing/src/options.rs@@ -100,10 +100,8 @@ impl ListingOptions {/// # use datafusion_catalog_listing::ListingOptions;/// # use datafusion_datasource_parquet::file_format::ParquetFormat;///- /// let listing_options = ListingOptions::new(Arc::new(- /// ParquetFormat::default()- /// ))- /// .with_file_extension(".parquet");+ /// let listing_options = ListingOptions::new(Arc::new(ParquetFormat::default()))+ /// .with_file_extension(".parquet");////// assert_eq!(listing_options.file_extension, ".parquet");/// ```@@ -123,10 +121,8 @@ impl ListingOptions {/// # use datafusion_datasource_parquet::file_format::ParquetFormat;////// let extension = Some(".parquet");- /// let listing_options = ListingOptions::new(Arc::new(- /// ParquetFormat::default()- /// ))- /// .with_file_extension_opt(extension);+ /// let listing_options = ListingOptions::new(Arc::new(ParquetFormat::default()))+ /// .with_file_extension_opt(extension);////// assert_eq!(listing_options.file_extension, ".parquet");/// ```@@ -216,10 +212,8 @@ impl ListingOptions {/// # use datafusion_catalog_listing::ListingOptions;/// # use datafusion_datasource_parquet::file_format::ParquetFormat;///- /// let listing_options = ListingOptions::new(Arc::new(- /// ParquetFormat::default()- /// ))- /// .with_collect_stat(true);+ /// let listing_options =+ /// ListingOptions::new(Arc::new(ParquetFormat::default())).with_collect_stat(true);////// assert_eq!(listing_options.collect_stat, true);/// ```@@ -235,10 +229,8 @@ impl ListingOptions {/// # use datafusion_catalog_listing::ListingOptions;/// # use datafusion_datasource_parquet::file_format::ParquetFormat;///- /// let listing_options = ListingOptions::new(Arc::new(- /// ParquetFormat::default()- /// ))- /// .with_target_partitions(8);+ /// let listing_options =+ /// ListingOptions::new(Arc::new(ParquetFormat::default())).with_target_partitions(8);////// assert_eq!(listing_options.target_partitions, 8);/// ```@@ -255,15 +247,11 @@ impl ListingOptions {/// # use datafusion_catalog_listing::ListingOptions;/// # use datafusion_datasource_parquet::file_format::ParquetFormat;///- /// // Tell datafusion that the files are sorted by column "a"- /// let file_sort_order = vec![vec![- /// col("a").sort(true, true)- /// ]];+ /// // Tell datafusion that the files are sorted by column "a"+ /// let file_sort_order = vec![vec![col("a").sort(true, true)]];///- /// let listing_options = ListingOptions::new(Arc::new(- /// ParquetFormat::default()- /// ))- /// .with_file_sort_order(file_sort_order.clone());+ /// let listing_options = ListingOptions::new(Arc::new(ParquetFormat::default()))+ /// .with_file_sort_order(file_sort_order.clone());////// assert_eq!(listing_options.file_sort_order, file_sort_order);/// ```