This is an automated email from the ASF dual-hosted git repository.
jakevin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 305625ac6d minor: fix comment docs (#6473)
305625ac6d is described below
commit 305625ac6d5e72e3069d9ee2c64418ded69de098
Author: Folyd <[email protected]>
AuthorDate: Mon May 29 23:45:07 2023 +0800
minor: fix comment docs (#6473)
---
datafusion/core/src/execution/context.rs | 12 ++++++------
datafusion/execution/src/object_store.rs | 1 +
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/datafusion/core/src/execution/context.rs
b/datafusion/core/src/execution/context.rs
index bbfdf48d5c..f43d7c87c4 100644
--- a/datafusion/core/src/execution/context.rs
+++ b/datafusion/core/src/execution/context.rs
@@ -129,7 +129,7 @@ use super::options::{
};
/// DataFilePaths adds a method to convert strings and vector of strings to
vector of [`ListingTableUrl`] URLs.
-/// This allows methods such [`SessionContext::read_csv`] and
`[`SessionContext::read_avro`]
+/// This allows methods such [`SessionContext::read_csv`] and
[`SessionContext::read_avro`]
/// to take either a single file or multiple files.
pub trait DataFilePaths {
/// Parse to a vector of [`ListingTableUrl`] URLs.
@@ -777,8 +777,8 @@ impl SessionContext {
/// Note in SQL queries, function names are looked up using
/// lowercase unless the query uses quotes. For example,
///
- /// `SELECT MY_FUNC(x)...` will look for a function named `"my_func"`
- /// `SELECT "my_FUNC"(x)` will look for a function named `"my_FUNC"`
+ /// - `SELECT MY_FUNC(x)...` will look for a function named `"my_func"`
+ /// - `SELECT "my_FUNC"(x)` will look for a function named `"my_FUNC"`
pub fn register_udf(&self, f: ScalarUDF) {
self.state
.write()
@@ -791,8 +791,8 @@ impl SessionContext {
/// Note in SQL queries, aggregate names are looked up using
/// lowercase unless the query uses quotes. For example,
///
- /// `SELECT MY_UDAF(x)...` will look for an aggregate named `"my_udaf"`
- /// `SELECT "my_UDAF"(x)` will look for an aggregate named `"my_UDAF"`
+ /// - `SELECT MY_UDAF(x)...` will look for an aggregate named `"my_udaf"`
+ /// - `SELECT "my_UDAF"(x)` will look for an aggregate named `"my_UDAF"`
pub fn register_udaf(&self, f: AggregateUDF) {
self.state
.write()
@@ -938,7 +938,7 @@ impl SessionContext {
))
}
- /// Registers a [`ListingTable]` that can assemble multiple files
+ /// Registers a [`ListingTable`] that can assemble multiple files
/// from locations in an [`ObjectStore`] instance into a single
/// table.
///
diff --git a/datafusion/execution/src/object_store.rs
b/datafusion/execution/src/object_store.rs
index d5b7e48d6f..803f703452 100644
--- a/datafusion/execution/src/object_store.rs
+++ b/datafusion/execution/src/object_store.rs
@@ -119,6 +119,7 @@ impl std::fmt::Display for ObjectStoreUrl {
///
/// <!-- is in a different crate so normal rustdoc links don't work -->
/// [`ListingTableUrl`]:
https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingTableUrl.html
+/// [`ObjectStore`]: object_store::ObjectStore
pub trait ObjectStoreRegistry: Send + Sync + std::fmt::Debug + 'static {
/// If a store with the same key existed before, it is replaced and
returned
fn register_store(
