docs: Mention r_bg()$get_result() more prominently (#271)

r-lib · Jan 18, 2024 · ad19590 · ad19590
1 parent 4fc82a3
commit ad19590
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/R/eval-bg.R b/R/eval-bg.R
@@ -3,6 +3,8 @@
 #'
 #' Starts evaluating an R function call in a background R process, and
 #' returns immediately.
+#' Use `p$get_result()` to collect the result or to throw an error
+#' if the background computation failed.
 #'
 #' @inheritSection r Security considerations
 #' @inheritParams r

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