From f0a3a901e388c6b69c62e054625616853156d095 Mon Sep 17 00:00:00 2001 From: Salim B Date: Tue, 24 Sep 2024 02:07:13 +0200 Subject: [PATCH 1/3] Tweak doc formatting --- R/remote.R | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/R/remote.R b/R/remote.R index b267e2966..781b6119d 100644 --- a/R/remote.R +++ b/R/remote.R @@ -7,13 +7,13 @@ #' the query plan (as computed by the remote database). `remote_src()` and #' `remote_con()` give the dplyr source and DBI connection respectively. #' -#' @param x Remote table, currently must be a [tbl_sql]. +#' @param x Remote table, currently must be a [`tbl_sql`]. #' @param null_if_local Return `NULL` if the remote table is created via -#' `tbl_lazy()` or `lazy_frame()`? +#' [tbl_lazy()] or [lazy_frame()]? #' @param cte `r lifecycle::badge("deprecated")` -#' Use the `render_otions` argument instead. +#' Use the `sql_options` argument instead. #' @param sql_options `r lifecycle::badge("experimental")` -#' SQL rendering options generated by `sql_options()`. +#' SQL rendering options generated by [sql_options()]. #' @param ... Additional arguments passed on to methods. #' @return The value, or `NULL` if not remote table, or not applicable. #' For example, computed queries do not have a "name" From 722e19907d309e5b4cbd8b32946f953029785dbf Mon Sep 17 00:00:00 2001 From: Salim B Date: Tue, 24 Sep 2024 02:10:59 +0200 Subject: [PATCH 2/3] Tweak return val doc --- R/remote.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/remote.R b/R/remote.R index 781b6119d..3a94c5220 100644 --- a/R/remote.R +++ b/R/remote.R @@ -15,8 +15,8 @@ #' @param sql_options `r lifecycle::badge("experimental")` #' SQL rendering options generated by [sql_options()]. #' @param ... Additional arguments passed on to methods. -#' @return The value, or `NULL` if not remote table, or not applicable. -#' For example, computed queries do not have a "name" +#' @return A string, or `NULL` if not a remote table, or not applicable. +#' For example, computed queries do not have a "name". #' @export #' @examples #' mf <- memdb_frame(x = 1:5, y = 5:1, .name = "blorp") From e6950d032eecdda7314801a22d9472ecd477d72d Mon Sep 17 00:00:00 2001 From: hadley Date: Fri, 29 Nov 2024 19:57:11 +0000 Subject: [PATCH 3/3] Document --- man/remote_name.Rd | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/man/remote_name.Rd b/man/remote_name.Rd index 2c2d70f87..d24445e4c 100644 --- a/man/remote_name.Rd +++ b/man/remote_name.Rd @@ -22,22 +22,22 @@ remote_query(x, cte = FALSE, sql_options = NULL) remote_query_plan(x, ...) } \arguments{ -\item{x}{Remote table, currently must be a \link{tbl_sql}.} +\item{x}{Remote table, currently must be a \code{\link{tbl_sql}}.} \item{null_if_local}{Return \code{NULL} if the remote table is created via -\code{tbl_lazy()} or \code{lazy_frame()}?} +\code{\link[=tbl_lazy]{tbl_lazy()}} or \code{\link[=lazy_frame]{lazy_frame()}}?} \item{cte}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} -Use the \code{render_otions} argument instead.} +Use the \code{sql_options} argument instead.} \item{sql_options}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -SQL rendering options generated by \code{sql_options()}.} +SQL rendering options generated by \code{\link[=sql_options]{sql_options()}}.} \item{...}{Additional arguments passed on to methods.} } \value{ -The value, or \code{NULL} if not remote table, or not applicable. -For example, computed queries do not have a "name" +A string, or \code{NULL} if not a remote table, or not applicable. +For example, computed queries do not have a "name". } \description{ \code{remote_name()} gives the unescaped name of the remote table, or \code{NULL} if it