docs: superseded

insightsengineering · Oct 31, 2024 · c668d98 · c668d98
1 parent af7054b
commit c668d98
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/R/qenv-get_var.R b/R/qenv-get_var.R
@@ -2,7 +2,7 @@
 #'
 #' @description
 #' `r lifecycle::badge("superseded")` by native \R operators/functions:
-#' `x[[name]]`, `x$name` or `get(name, envir = qenv)`.
+#' `x[[name]]`, `x$name` or [get()].
 #'
 #' Retrieve variables from the `qenv` environment.
 #'

diff --git a/R/qenv-join.R b/R/qenv-join.R
@@ -1,7 +1,11 @@
 #' Join `qenv` objects
 #'
+#' @description
+#' `r lifecycle::badge("superseded")` by [c()].
+#'
 #' Checks and merges two `qenv` objects into one `qenv` object.
 #'
+#' @details
 #' Any common code at the start of the `qenvs` is only placed once at the start of the joined `qenv`.
 #' This allows consistent behavior when joining `qenvs` which share a common ancestor.
 #' See below for an example.

diff --git a/man/get_var.Rd b/man/get_var.Rd
diff --git a/man/join.Rd b/man/join.Rd