update Rd

poissonconsulting · Aug 5, 2024 · d91a177 · d91a177
1 parent 06691ea
commit d91a177
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/R/local-timer.R b/R/local-timer.R
@@ -2,11 +2,14 @@
 #'
 #' @inheritParams params
 #'
-#' @return xx
+#' @return An invisible copy of the hmstimer object.
 #' @export
 #'
 #' @examples
-#' local_timer()
+#' fun <- function() {
+#'   local_timer()
+#' }
+#' fun()
 local_timer <- function(.local_envir = rlang::caller_env()) {
   chk_env(.local_envir)
 

diff --git a/man/local_timer.Rd b/man/local_timer.Rd