From f0a3a901e388c6b69c62e054625616853156d095 Mon Sep 17 00:00:00 2001 From: Salim B Date: Tue, 24 Sep 2024 02:07:13 +0200 Subject: [PATCH 1/2] 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/2] 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")