Document on_load() detail (#1696)

r-lib · Mar 13, 2024 · 1fa327a · 1fa327a
1 parent 84deb87
commit 1fa327a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/R/aaa.R b/R/aaa.R
@@ -69,6 +69,10 @@ the <- new.env(parent = emptyenv())
 #' `on_load()` is implemented via `.onLoad()` and requires
 #' `run_on_load()` to be called from that hook.
 #'
+#' The expressions inside `on_load()` do not undergo static analysis
+#' by `R CMD check`. Therefore, it is advisable to only use
+#' simple function calls inside `on_load()`.
+#'
 #' @examples
 #' quote({  # Not run
 #' 

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