Skip to content

Commit af0c23f

Browse files
authored
Clarify what you are meant to do with furrr_options() (#294)
1 parent 3b3e004 commit af0c23f

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

R/furrr-options.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#' Options to fine tune furrr
22
#'
3-
#' These options fine tune furrr functions, such as [future_map()]. They
4-
#' are either used by furrr directly, or are passed on to [future::future()].
3+
#' `furrr_options()` returns an object that can be supplied as the `.options`
4+
#' argument for furrr functions, such as [future_map()]. The options are either
5+
#' used by furrr directly, or are passed on to [future::future()].
56
#'
67
#' @param ... These dots are reserved for future extensibility and must
78
#' be empty.

man/furrr_options.Rd

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)