add missing return statements

Author: pat-s

R/auth.R

@@ -29,6 +29,7 @@
 #'      token: <token>
 #'      ```
 #' @export
+#' @return Returns `TRUE` (invisibly).
 #' @examples
 #' \dontrun{
 #' browse_circle_token()
@@ -52,14 +53,14 @@ browse_circle_token <- function() { # nocov start
 #' @title Open circle Configuration file
 #' @description
 #'   Opens `~/.circleci/cli.yml`.
+#' @return No return value, called for side effects.
 #' @export
 edit_circle_config <- function() { # nocov start
   usethis::edit_file("~/.circleci/cli.yml")
 } # nocov end
 
 # check if API key is stored in ~/.circleci/cli.yml
 circle_check_api_key <- function() {
-
   if (!Sys.getenv("R_CIRCLE") == "") {
     token <- Sys.getenv("R_CIRCLE")
 
@@ -71,7 +72,6 @@ circle_check_api_key <- function() {
     # some checks for ~/.circleci/cli.yml
 
     if (!file.exists("~/.circleci/cli.yml")) {
-
       cli::cli_alert_danger("To interact with the Circle CI API, an API token is
         required. Please call {.fun browse_circle_token} first.
         Alternatively, set the API key via env vars {.var R_CIRCLE}.",
@@ -91,7 +91,6 @@ circle_check_api_key <- function() {
 
     return(token)
   }
-
 } # nocov end
 
 is_token <- function(token) {

R/helpers-github.R

@@ -9,6 +9,8 @@
 #'   The path to a GitHub-enabled Git repository (or a subdirectory thereof).
 #' @template token
 #' @template remote
+#' @return Object of class `gh_response` (list type) with information about the
+#'   queried repository.
 #' @keywords internal
 github_info <- function(path = ".",
                         remote = "origin",

R/use-circle-deploy.R

@@ -20,6 +20,7 @@
 #' `usethis::github_token()` can be used to check if one is already set.
 #' If none is set, this function will prompt you to create one.
 #'
+#' @return No return value, called for side effects.
 #' @examples
 #' \dontrun{
 #' use_circle_deploy()

codemeta.json

@@ -5,7 +5,7 @@
   ],
   "@type": "SoftwareSourceCode",
   "identifier": "circle",
-  "description": "Tools for interacting with the 'Circle CI' API.  Besides\n    executing common tasks such as querying build logs and restarting\n    builds, this package also helps setting up permissions to deploy from\n    builds.",
+  "description": "Tools for interacting with the 'Circle CI' API\n    (<https://circleci.com/docs/api/v2/>). Besides executing common tasks\n    such as querying build logs and restarting builds, this package also\n    helps setting up permissions to deploy from builds.",
   "name": "circle: R Client Package for Circle CI",
   "codeRepository": "https://github.com/ropensci/circle",
   "relatedLink": [
@@ -236,7 +236,7 @@
   ],
   "releaseNotes": "https://github.com/ropensci/circle/blob/master/NEWS.md",
   "readme": "https://github.com/ropensci/circle/blob/main/README.md",
-  "fileSize": "2167.786KB",
+  "fileSize": "2168.45KB",
   "issueTracker": "https://github.com/ropensci/circle/issues",
   "developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html",
   "contIntegration": ["https://circleci.com/gh/ropensci/circle", "https://codecov.io/gh/ropensci/circle"],