document

tadascience · Feb 23, 2024 · 6f4d5e7 · 6f4d5e7
1 parent 414aca6
commit 6f4d5e7
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/R/to.R b/R/to.R
@@ -1,7 +1,19 @@
 link <- function(url, text) {
   glue::glue('<a href="{url}">{text}</a>')
 }
-
+#' Create a link to a function or a package
+#'
+#' @param topic topic
+#' @param package package
+#'
+#' @examples
+#' link::to
+#' \dontrun{
+#'   link::to(dplyr::summarise)
+#'   link::to(package = "dplyr")
+#'   link::to("gather", package = "tidyr")
+#' }
+#'
 #' @importFrom rlang is_string is_call enexpr
 #' @importFrom cli cli_abort
 #' @export

diff --git a/man/to.Rd b/man/to.Rd