docs: Add function examples.

R/box_lsp.R

@@ -38,14 +38,19 @@ process_module <- function(sym_name, signature, action) {
   action$parse(func_sig[[3L]])
 }
 
-#' Box::use Document Parser
+#' 'box::use' Document Parser
 #'
 #' Custom \{languageserver\} parser hook for \{box\} modules.
 #'
 #' @param expr An R expression to evaluate
 #' @param action A list of action functions from `languageserver:::parse_expr()`.
 #' @returns Used for side-effects provided by the `action` list of functions.
 #'
+#' @examples
+#' \dontrun{
+#'   box_use_parser(expr = expression(box::use(fs)), action = new.env())
+#' }
+#'
 #' @export
 box_use_parser <- function(expr, action) {
   call <- match.call(box::use, expr)

R/utils.R

@@ -3,6 +3,11 @@
 #' @param file_path File name to append `{box.lsp}` configuration lines.
 #' @returns Writes configuration lines to `file_path`.
 #'
+#' @examples
+#' \dontrun{
+#'   use_box_lsp()
+#' }
+#'
 #' @export
 use_box_lsp <- function(file_path = ".Rprofile") {
   rprofile <- fs::path_package("box.lsp", "Rprofile.R")