docs: improve example and doc of keyring::key_set()

ropensci-review-tools · Dec 20, 2024 · d908e3f · d908e3f
1 parent 315b94f
commit d908e3f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -55,9 +55,10 @@ Sys.setenv("DEEPL_API_URL" = "https://api.deepl.com")
 Set your API key via the environment variable `DEEPL_API_KEY`.
 
 You could store it with the [keyring](https://r-lib.github.io/keyring/index.html) package, once per user/machine.
+The code below will prompt you to enter your API key interactively.
 
 ```r
-keyring::key_set("deepl") # will prompt you to enter the key interactively
+keyring::key_set("deepl", prompt = "API key:") 
 ```
 
 In any script you use babeldown, you'd retrieve the key like so:

diff --git a/README.md b/README.md
@@ -53,10 +53,11 @@ Set your API key via the environment variable `DEEPL_API_KEY`.
 
 You could store it with the
 [keyring](https://r-lib.github.io/keyring/index.html) package, once per
-user/machine.
+user/machine. The code below will prompt you to enter your API key
+interactively.
 
 ``` r
-keyring::key_set("deepl") # will prompt you to enter the key interactively
+keyring::key_set("deepl", prompt = "API key:") 
 ```
 
 In any script you use babeldown, you’d retrieve the key like so: