From 88ae77d59206e19f11944690e58a86aa8170c9ab Mon Sep 17 00:00:00 2001 From: Dewey Dunnington Date: Mon, 6 Nov 2023 10:19:27 -0400 Subject: [PATCH] better document depth param --- r/adbcdrivermanager/R/adbc.R | 5 +++-- r/adbcdrivermanager/man/adbc_connection_get_info.Rd | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/r/adbcdrivermanager/R/adbc.R b/r/adbcdrivermanager/R/adbc.R index 6be5fceb3b..8a3334657a 100644 --- a/r/adbcdrivermanager/R/adbc.R +++ b/r/adbcdrivermanager/R/adbc.R @@ -137,8 +137,9 @@ adbc_connection_release <- function(connection) { #' @param info_codes A list of metadata codes to fetch, or NULL to fetch all. #' Valid values are documented in the adbc.h header. #' @param depth The level of nesting to display. If 0, display all levels. If 1, -#' display only catalogs (i.e. catalog_schemas will be null). If 2, display -#' only catalogs and schemas (i.e. db_schema_tables will be null), and so on. +#' display only catalogs (i.e., catalog_schemas will be null). If 2, display +#' only catalogs and schemas (i.e., db_schema_tables will be null). If 3, +#' display only catalogs, schemas, and tables. #' @param catalog Only show tables in the given catalog. If NULL, do not filter #' by catalog. If an empty string, only show tables without a catalog. May be #' a search pattern. diff --git a/r/adbcdrivermanager/man/adbc_connection_get_info.Rd b/r/adbcdrivermanager/man/adbc_connection_get_info.Rd index bc90893ffc..5318df0310 100644 --- a/r/adbcdrivermanager/man/adbc_connection_get_info.Rd +++ b/r/adbcdrivermanager/man/adbc_connection_get_info.Rd @@ -60,8 +60,9 @@ adbc_connection_quote_string(connection, value, ...) Valid values are documented in the adbc.h header.} \item{depth}{The level of nesting to display. If 0, display all levels. If 1, -display only catalogs (i.e. catalog_schemas will be null). If 2, display -only catalogs and schemas (i.e. db_schema_tables will be null), and so on.} +display only catalogs (i.e., catalog_schemas will be null). If 2, display +only catalogs and schemas (i.e., db_schema_tables will be null). If 3, +display only catalogs, schemas, and tables.} \item{catalog}{Only show tables in the given catalog. If NULL, do not filter by catalog. If an empty string, only show tables without a catalog. May be