From 9d22054a1fc1dd0a5bc2b499a48df92fc2788444 Mon Sep 17 00:00:00 2001 From: Folyd Date: Sat, 3 Jun 2023 03:51:51 +0800 Subject: [PATCH] feat: fix docs (#6534) Co-authored-by: Andrew Lamb --- .../core/src/catalog/information_schema.rs | 2 +- datafusion/core/src/catalog/listing_schema.rs | 16 +++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/datafusion/core/src/catalog/information_schema.rs b/datafusion/core/src/catalog/information_schema.rs index 6e3a9acbb5eb..04de11dc6b07 100644 --- a/datafusion/core/src/catalog/information_schema.rs +++ b/datafusion/core/src/catalog/information_schema.rs @@ -17,7 +17,7 @@ //! Implements the SQL [Information Schema] for DataFusion. //! -//! Information Schema] +//! [Information Schema]: https://en.wikipedia.org/wiki/Information_schema use async_trait::async_trait; use std::{any::Any, sync::Arc}; diff --git a/datafusion/core/src/catalog/listing_schema.rs b/datafusion/core/src/catalog/listing_schema.rs index 50f733c3236f..cb63659997b5 100644 --- a/datafusion/core/src/catalog/listing_schema.rs +++ b/datafusion/core/src/catalog/listing_schema.rs @@ -32,19 +32,21 @@ use std::collections::{HashMap, HashSet}; use std::path::Path; use std::sync::{Arc, Mutex}; -/// A `SchemaProvider` that scans an `ObjectStore` to automatically discover tables +/// A [`SchemaProvider`] that scans an [`ObjectStore`] to automatically discover tables /// /// A subfolder relationship is assumed, i.e. given: -/// authority = s3://host.example.com:3000 -/// path = /data/tpch -/// factory = `DeltaTableFactory` +/// - authority = `s3://host.example.com:3000` +/// - path = `/data/tpch` +/// - factory = `DeltaTableFactory` /// /// A table called "customer" will be registered for the folder: -/// s3://host.example.com:3000/data/tpch/customer +/// `s3://host.example.com:3000/data/tpch/customer` /// /// assuming it contains valid deltalake data, i.e: -/// s3://host.example.com:3000/data/tpch/customer/part-00000-xxxx.snappy.parquet -/// s3://host.example.com:3000/data/tpch/customer/_delta_log/ +/// - `s3://host.example.com:3000/data/tpch/customer/part-00000-xxxx.snappy.parquet` +/// - `s3://host.example.com:3000/data/tpch/customer/_delta_log/` +/// +/// [`ObjectStore`]: object_store::ObjectStore pub struct ListingSchemaProvider { authority: String, path: object_store::path::Path,