[arrow-rs] branch master updated: Minor: Improve API docs for FlightSQL metadata builders (#4667)

[alamb]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new 946e17d792 Minor: Improve API docs for FlightSQL metadata builders 
(#4667)
946e17d792 is described below

commit 946e17d792b2f67f4b7358fb8bd029e82b1074cf
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Wed Aug 9 09:23:38 2023 -0500

    Minor: Improve API docs for FlightSQL metadata builders (#4667)
---
 arrow-flight/src/sql/metadata/mod.rs       | 4 ++++
 arrow-flight/src/sql/metadata/sql_info.rs  | 4 ++--
 arrow-flight/src/sql/metadata/xdbc_info.rs | 4 ++--
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/arrow-flight/src/sql/metadata/mod.rs 
b/arrow-flight/src/sql/metadata/mod.rs
index 72c882f385..71551f1849 100644
--- a/arrow-flight/src/sql/metadata/mod.rs
+++ b/arrow-flight/src/sql/metadata/mod.rs
@@ -21,10 +21,14 @@
 //! - [`GetCatalogsBuilder`] for building responses to [`CommandGetCatalogs`] 
queries.
 //! - [`GetDbSchemasBuilder`] for building responses to 
[`CommandGetDbSchemas`] queries.
 //! - [`GetTablesBuilder`]for building responses to [`CommandGetTables`] 
queries.
+//! - [`SqlInfoDataBuilder`]for building responses to [`CommandGetSqlInfo`] 
queries.
+//! - [`XdbcTypeInfoDataBuilder`]for building responses to 
[`CommandGetXdbcTypeInfo`] queries.
 //!
 //! [`CommandGetCatalogs`]: crate::sql::CommandGetCatalogs
 //! [`CommandGetDbSchemas`]: crate::sql::CommandGetDbSchemas
 //! [`CommandGetTables`]: crate::sql::CommandGetTables
+//! [`CommandGetSqlInfo`]: crate::sql::CommandGetSqlInfo
+//! [`CommandGetXdbcTypeInfo`]: crate::sql::CommandGetXdbcTypeInfo
 
 mod catalogs;
 mod db_schemas;
diff --git a/arrow-flight/src/sql/metadata/sql_info.rs 
b/arrow-flight/src/sql/metadata/sql_info.rs
index d0c9cedbcf..b37ac85308 100644
--- a/arrow-flight/src/sql/metadata/sql_info.rs
+++ b/arrow-flight/src/sql/metadata/sql_info.rs
@@ -334,8 +334,8 @@ impl SqlInfoUnionBuilder {
 /// [`CommandGetSqlInfo`] are metadata requests used by a Flight SQL
 /// server to communicate supported capabilities to Flight SQL clients.
 ///
-/// Servers constuct - usually static - [`SqlInfoData`] via the 
[SqlInfoDataBuilder`],
-/// and build responses by passing the [`GetSqlInfoBuilder`].
+/// Servers constuct - usually static - [`SqlInfoData`] via the 
[`SqlInfoDataBuilder`],
+/// and build responses using [`CommandGetSqlInfo::into_builder`]
 #[derive(Debug, Clone, PartialEq)]
 pub struct SqlInfoDataBuilder {
     /// Use BTreeMap to ensure the values are sorted by value as
diff --git a/arrow-flight/src/sql/metadata/xdbc_info.rs 
b/arrow-flight/src/sql/metadata/xdbc_info.rs
index cecef1b49e..b70a3ce3cb 100644
--- a/arrow-flight/src/sql/metadata/xdbc_info.rs
+++ b/arrow-flight/src/sql/metadata/xdbc_info.rs
@@ -70,8 +70,8 @@ pub struct XdbcTypeInfo {
 /// [`CommandGetXdbcTypeInfo`] are metadata requests used by a Flight SQL
 /// server to communicate supported capabilities to Flight SQL clients.
 ///
-/// Servers constuct - usually static - [`XdbcTypeInfoData`] via the 
[XdbcTypeInfoDataBuilder`],
-/// and build responses by passing the [`GetXdbcTypeInfoBuilder`].
+/// Servers constuct - usually static - [`XdbcTypeInfoData`] via the 
[`XdbcTypeInfoDataBuilder`],
+/// and build responses using [`CommandGetXdbcTypeInfo::into_builder`].
 pub struct XdbcTypeInfoData {
     batch: RecordBatch,
 }