From a3a3040ef20148f775dcb7094dc75d1ae17e626c Mon Sep 17 00:00:00 2001 From: Salim B Date: Sun, 15 Sep 2024 14:43:50 +0200 Subject: [PATCH 1/4] docs: Tweak formatting --- R/db-interface.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/db-interface.R b/R/db-interface.R index b928ae303..eb61b4bd1 100644 --- a/R/db-interface.R +++ b/R/db-interface.R @@ -1,7 +1,7 @@ #' Copy data model to data source #' #' @description -#' `copy_dm_to()` takes a [dplyr::src_dbi] object or a [`DBI::DBIConnection-class`] object as its first argument +#' `copy_dm_to()` takes a [`dplyr::src_dbi`] object or a [`DBI::DBIConnection-class`] object as its first argument #' and a [`dm`] object as its second argument. #' The latter is copied to the former. #' The default is to create temporary tables, set `temporary = FALSE` to create permanent tables. @@ -24,7 +24,7 @@ #' #' Not all DBMS are supported. #' @param table_names Desired names for the tables on `dest`; the names within the `dm` remain unchanged. -#' Can be `NULL`, a named character vector, or a vector of [DBI::Id] objects. +#' Can be `NULL`, a named character vector, or a vector of [`DBI::Id`] objects. #' #' If left `NULL` (default), the names will be determined automatically depending on the `temporary` argument: #' From 80c9f87d75c64677684a262d4372794d25b9cf72 Mon Sep 17 00:00:00 2001 From: Salim B Date: Wed, 18 Sep 2024 22:23:47 +0200 Subject: [PATCH 2/4] docs: Use more roxygen links --- R/validate.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/validate.R b/R/validate.R index 6372eafcd..01889c4db 100644 --- a/R/validate.R +++ b/R/validate.R @@ -103,7 +103,7 @@ dm_validate <- function(x) { #' Validator #' -#' `validate_dm()` has been replaced by `dm_validate()` for consistency. +#' `validate_dm()` has been replaced by [dm_validate()] for consistency. #' #' @param x An object. #' From 597d3866eb233e9d85e40c6b2892ba505176faed Mon Sep 17 00:00:00 2001 From: Salim B Date: Wed, 18 Sep 2024 22:25:20 +0200 Subject: [PATCH 3/4] Update zzx-deprecated.R docs: Use more roxygen links --- R/zzx-deprecated.R | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/R/zzx-deprecated.R b/R/zzx-deprecated.R index a5e9388e1..02f75b979 100644 --- a/R/zzx-deprecated.R +++ b/R/zzx-deprecated.R @@ -749,7 +749,8 @@ dm_squash_to_tbl <- function(dm, start, ..., join = left_join) { #' @description #' `rows_truncate()` is deprecated as of dm 1.0.0, because it's a DDL operation -#' and requires different permissions than the `dplyr::rows_*()` functions. +#' and requires different permissions than the +#' [`dplyr::rows_*()`][dplyr::rows_insert()] functions. #' #' @rdname deprecated #' @keywords internal From 51eef30cef8f2765cef8799255b0de2b838cead8 Mon Sep 17 00:00:00 2001 From: Salim B Date: Wed, 18 Sep 2024 22:51:59 +0200 Subject: [PATCH 4/4] docs: Use more roxygen links --- R/select.R | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/R/select.R b/R/select.R index c70ba239c..4ca7ed425 100644 --- a/R/select.R +++ b/R/select.R @@ -1,22 +1,23 @@ #' Rename columns #' #' @description -#' Rename the columns of your [`dm`] using syntax that is similar to `dplyr::rename()`. +#' Rename the columns of your [`dm`] using syntax that is similar to [dplyr::rename()]. #' #' @inheritParams dm_zoom_to #' @param ... One or more unquoted expressions separated by commas. #' You can treat -#' variable names as if they were positions, and use expressions like x:y +#' variable names as if they were positions, and use expressions like `x:y` #' to select the ranges of variables. #' -#' Use named arguments, e.g. new_name = old_name, to rename the selected variables. +#' Use named arguments, e.g. `new_name = old_name`, to rename the selected variables. #' #' The arguments in ... are automatically quoted and evaluated in a context where #' column names represent column positions. #' They also support unquoting and splicing. #' See `vignette("programming", package = "dplyr")` for an introduction to those concepts. #' -#' See select helpers for more details, and the examples about tidyselect helpers, such as starts_with(), everything(), ... +#' See select helpers for more details, and the examples about [tidyselect +#' helpers][tidyselect::select_helpers], such as `starts_with()`, `everything()`, etc. #' #' @details If key columns are renamed, then the meta-information of the `dm` is updated accordingly. #' @@ -39,7 +40,7 @@ dm_rename <- function(dm, table, ...) { #' Select columns #' #' @description -#' Select columns of your [`dm`] using syntax that is similar to `dplyr::select()`. +#' Select columns of your [`dm`] using syntax that is similar to [dplyr::select()]. #' #' @inheritParams dm_rename #' @details If key columns are renamed, then the meta-information of the `dm` is updated accordingly.