diff --git a/R/add_rstudio_files.R b/R/add_rstudio_files.R index a52574d5..f2a4eb64 100644 --- a/R/add_rstudio_files.R +++ b/R/add_rstudio_files.R @@ -74,6 +74,7 @@ add_rstudio_files <- function( #' #' @note #' In previous versions, this function was called add_rconnect_file. +#' #' @section List of excluded files in `.rscignore`: #' * .here #' * CODE_OF_CONDUCT.md diff --git a/R/config.R b/R/config.R index 08419402..d52997d7 100644 --- a/R/config.R +++ b/R/config.R @@ -207,6 +207,7 @@ guess_lines_to_config_file <- function(guess_text) { #' feature). #' #' @export +#' @return character string giving the path to the `{golem}` config-file get_current_config <- function(path = getwd()) { # We check whether we can guess where the config file is path_conf <- guess_where_config(path) diff --git a/R/golem_welcome_page.R b/R/golem_welcome_page.R index 2cce0f87..2b12f5f6 100644 --- a/R/golem_welcome_page.R +++ b/R/golem_welcome_page.R @@ -3,6 +3,8 @@ #' @importFrom shiny tagList tags #' #' @export +#' +#' @return A welcome page for your {golem} app golem_welcome_page <- function() { tagList( tags$head( diff --git a/R/is_golem.R b/R/is_golem.R index d391582d..a2357d82 100644 --- a/R/is_golem.R +++ b/R/is_golem.R @@ -5,6 +5,8 @@ #' @param path Path to the directory to check. #' Defaults to the current working directory. #' +#' @return A boolean, `TRUE` if the directory is a golem-based app, `FALSE` else. +#' #' @export #' #' @examples diff --git a/man/get_current_config.Rd b/man/get_current_config.Rd index 6555ff78..a6cd4849 100644 --- a/man/get_current_config.Rd +++ b/man/get_current_config.Rd @@ -12,6 +12,9 @@ the usual value is the \code{{golem}}-package top-level directory but a user supplied config is now supported (see \strong{Details} for how to use this feature).} } +\value{ +character string giving the path to the \code{{golem}} config-file +} \description{ This function tries to find the path to the \code{{golem}} config-file currently used. If the config-file is not found, the user is asked if they want to set parts diff --git a/man/golem_welcome_page.Rd b/man/golem_welcome_page.Rd index 489e34eb..a6bcf3f9 100644 --- a/man/golem_welcome_page.Rd +++ b/man/golem_welcome_page.Rd @@ -6,6 +6,9 @@ \usage{ golem_welcome_page() } +\value{ +A welcome page for your {golem} app +} \description{ Welcome Page } diff --git a/man/is_golem.Rd b/man/is_golem.Rd index 784130f9..bc359398 100644 --- a/man/is_golem.Rd +++ b/man/is_golem.Rd @@ -10,6 +10,9 @@ is_golem(path = getwd()) \item{path}{Path to the directory to check. Defaults to the current working directory.} } +\value{ +A boolean, \code{TRUE} if the directory is a golem-based app, \code{FALSE} else. +} \description{ Trying to guess if \code{path} is a golem-based app. }