Skip to content

Commit 82bb3fb

Browse files
committed
documentation updates
1 parent db11af5 commit 82bb3fb

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

R/module_teal_lockfile.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#' `renv::settings$snapshot.type("custom")` and configure the `renv.snapshot.filter` option.
2121
#'
2222
#' @section lockfile usage:
23-
#' After creating the lockfile, you can restore the application environment using `renv::restore()`.
23+
#' After creating the lockfile, you can restore the application's environment using `renv::restore()`.
2424
#'
2525
#' @seealso [renv::snapshot()], [renv::restore()].
2626
#'
@@ -79,7 +79,7 @@ srv_teal_lockfile <- function(id) {
7979
is_user_lockfile_set <- !identical(user_lockfile_path, "")
8080

8181
if (!is_lockfile_enabled) {
82-
logger::log_debug("'teal.lockfile.enable' option is set to false. Hiding a lockfile download button.")
82+
logger::log_debug("'teal.lockfile.enable' option is set to FALSE. Hiding a lockfile download button.")
8383
shinyjs::hide("lockFileLink")
8484
return(NULL)
8585
}

man/module_teal_lockfile.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/teal-options.Rmd

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,17 @@ Default: `FALSE`.
8686

8787
### `teal.lockfile.enable` (`logical`)
8888

89-
This enables app users to download `renv` lockfile by clicking "download lockfile" in the footer. If
90-
`teal.lockfile.path` is not specified then lockfile is created automatically by `teal`. To read more about
91-
lockfile usage creation check `?teal::teal_lockfile`.
89+
This enables app users to download `renv` lockfile by clicking "download lockfile" in the footer.
90+
If `teal.lockfile.path` is not specified then lockfile is created automatically by `teal`.
91+
92+
To read more about lockfile usage creation check `?teal::module_teal_lockfile`.
9293

9394
### `teal.lockfile.path` (`character`)
9495

95-
The path to the pre-computed `renv` lockfile linked by app developer. Lockfile will be available to download if
96-
`teal.lockfile.enable` is set to `TRUE`.
96+
The path to the pre-computed `renv` lockfile linked by app developer.
97+
Lockfile will be available to download if `teal.lockfile.enable` is set to `TRUE`.
98+
99+
To read more about lockfile usage creation check `?teal::module_teal_lockfile`.
97100

98101
# Deprecated options
99102

0 commit comments

Comments
 (0)