Skip to content

Commit

Permalink
doc: adding forgotten @return tag to some funs
Browse files Browse the repository at this point in the history
  • Loading branch information
ColinFay committed Aug 16, 2024
1 parent 069b097 commit 8d01d31
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions R/add_rstudio_files.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions R/config.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions R/golem_welcome_page.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
#' @importFrom shiny tagList tags
#'
#' @export
#'
#' @return A welcome page for your {golem} app
golem_welcome_page <- function() {
tagList(
tags$head(
Expand Down
2 changes: 2 additions & 0 deletions R/is_golem.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions man/get_current_config.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/golem_welcome_page.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/is_golem.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8d01d31

Please sign in to comment.