Adds value tag to exported methods

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
 Version: 0.2.0
-Date: 2023-12-14 19:49:39 UTC
-SHA: fcaf79252a96bd6debd797f62651204ebcaa0653
+Date: 2023-12-15 14:28:38 UTC
+SHA: e4e53f71654d196197b434cfa7ea4ca4aab6e6bd

R/connection-code.R

@@ -1,5 +1,7 @@
 #' Displays the code that will be used to recreate the connection
 #' @param con A `connConnection` object
+#' @returns It prints out the lines of code that this package will use
+#' to reconnect to the database.
 #' @export
 connection_code <- function(con) {
   session <- conn_session_get(con@id)

R/connection-pin-read.R

@@ -2,6 +2,8 @@
 #' @param board A `pins` board object
 #' @param name The name of the pin
 #' @param version The version of the pin to get (optional)
+#' @returns It will return either the database connection, or the remote table
+#' from a database.
 #' @export
 connection_pin_read <- function(board, name, version = NULL) {
   pinned <- pin_read(board = board, name = name, version = version)

R/connection-pin-write.R

@@ -2,6 +2,7 @@
 #' @param board A `pins` board object
 #' @param x A `connections` table or database connection
 #' @param ... Additional arguments to pass to `pins::pin_write()`
+#' @returns It returns no output.
 #' @export
 connection_pin_write <- function(board, x, ...) {
   write_pin_conn(

R/connection-view.R

@@ -5,7 +5,8 @@
 #' @param host Name of Host of the connection
 #' @param name Connection name
 #' @param connection_id Unique ID of the connection for the current session
-#'
+#' @returns It populates the RStudio Connections pane. It returns nothing to the
+#' console or session.
 #' @examples
 #' library(DBI)
 #' con <- connection_open(RSQLite::SQLite(), path = ":dbname:")