Skip to content

Commit a427faf

Browse files
Fix Rd mistake
1 parent 3cdd9b6 commit a427faf

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

R/registerDoFuture.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
#' Use the Foreach `%dopar%` Adapter with Futures
22
#'
3-
#' @param flavor Control how the adapter should behave.
4-
#' If `"%dopar%"`, it behaves as a classical foreach adapter.
5-
#' If `"%dofuture%"`, it behaves as if `%dofuture%` would have
6-
#' been used instead of `%dopar%`.
7-
#'
83
#' The `registerDoFuture()` function makes the
94
#' \code{\link[foreach:\%dopar\%]{\%dopar\%}} operator of the
105
#' \pkg{foreach} package to process foreach iterations via any of
@@ -15,6 +10,11 @@
1510
#' and packages making using the \pkg{foreach} framework._
1611
#' Neither the developer nor the end user has to change any code.
1712
#'
13+
#' @param flavor Control how the adapter should behave.
14+
#' If `"%dopar%"`, it behaves as a classical foreach adapter.
15+
#' If `"%dofuture%"`, it behaves as if `%dofuture%` would have
16+
#' been used instead of `%dopar%`.
17+
#'
1818
#' @section Parallel backends:
1919
#' To use futures with the \pkg{foreach} package and its
2020
#' \code{\link[foreach:\%dopar\%]{\%dopar\%}} operator, use

man/registerDoFuture.Rd

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

0 commit comments

Comments
 (0)