Skip to content

Commit 0ef3cfe

Browse files
committed
refactor(auth): rename to save_api_key
1 parent 127de77 commit 0ef3cfe

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

R/auth.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#' key](https://api.delphi.cmu.edu/epidata/admin/registration_form).
1212
#'
1313
#' API keys are strings read from the environment variable `DELPHI_EPIDATA_KEY`.
14-
#' We recommend setting your key with `set_api_key()`, which will modify your
14+
#' We recommend setting your key with `save_api_key()`, which will modify your
1515
#' `.Renviron` file and will persist your key across R sessions (see `?Startup`
1616
#' for a description of `.Renviron` files). Alternatively, you can modify the
1717
#' environment variable in the shell or with `Sys.setenv()`, but these will not
@@ -39,7 +39,7 @@ get_api_key <- function() {
3939
cli::cli_warn(
4040
c(
4141
"No API key found. You will be limited to non-complex queries and encounter rate limits if you proceed.",
42-
"i" = "See {.help set_api_key} for details on obtaining and setting API keys."
42+
"i" = "See {.help save_api_key} for details on obtaining and setting API keys."
4343
),
4444
.frequency = "regularly",
4545
.frequency_id = "delphi.epidata.key"
@@ -49,7 +49,7 @@ get_api_key <- function() {
4949

5050
#' @rdname get_api_key
5151
#' @export
52-
set_api_key <- function() {
52+
save_api_key <- function() {
5353
cli::cli_inform(
5454
c(
5555
"i" = "This function will open your .Renviron file in a text editor. You will need to

0 commit comments

Comments
 (0)