Update mentions of formula in documentation (#1220)

* check mentions of formulas, specifiy backward compatibility

* specificy R version for clarity

* revert formula comments, note for readme

* Completely remove lambda-formula mention

* Revert some removed lines

* Fix other-langs vignette

* Revert readme

---------

Co-authored-by: shikokuchuo <53399081+shikokuchuo@users.noreply.github.com>

Author: luisDVA

R/adverb-safely.R

@@ -13,8 +13,7 @@
 #' @param .f A function to modify, specified in one of the following ways:
 #'   * A named function, e.g. `mean`.
 #'   * An anonymous function, e.g. `\(x) x + 1` or `function(x) x + 1`.
-#'   * A formula, e.g. `~ .x + 1`. Only recommended if you require backward
-#'     compatibility with older versions of R.
+#'   * A formula, e.g. `~ .x + 1`. No longer recommended.
 #' @param otherwise Default value to use when an error occurs.
 #' @param quiet Hide errors (`TRUE`, the default), or display them
 #'   as they occur?

R/detect.R

@@ -6,8 +6,8 @@
 #'
 #'   * A named function, e.g. `mean`.
 #'   * An anonymous function, e.g. `\(x) x + 1` or `function(x) x + 1`.
-#'   * A formula, e.g. `~ .x + 1`. You must use `.x` to refer to the first
-#'     argument. No longer recommended.
+#'   * A formula, e.g. `~ .x + 1`. Use `.x` to refer to the first argument. No
+#'     longer recommended.
 #'   * A string, integer, or list, e.g. `"idx"`, `1`, or `list("idx", 1)` which
 #'     are shorthand for `\(x) pluck(x, "idx")`, `\(x) pluck(x, 1)`, and
 #'     `\(x) pluck(x, "idx", 1)` respectively. Optionally supply `.default` to
@@ -33,8 +33,7 @@
 #' 3:10 |> detect_index(is_even, .dir = "backward")
 #'
 #'
-#' # Since `.f` is passed to as_mapper(), you can supply a
-#' # lambda-formula or a pluck object:
+#' # Since `.f` is passed to as_mapper(), you can supply a pluck object:
 #' x <- list(
 #'   list(1, foo = FALSE),
 #'   list(2, foo = TRUE),
@@ -50,7 +49,13 @@
 #'
 #' # If you need to find all positions, use map_lgl():
 #' which(map_lgl(x, "foo"))
-detect <- function(.x, .f, ..., .dir = c("forward", "backward"), .default = NULL) {
+detect <- function(
+  .x,
+  .f,
+  ...,
+  .dir = c("forward", "backward"),
+  .default = NULL
+) {
   .f <- as_predicate(.f, ..., .mapper = TRUE)
   .dir <- arg_match0(.dir, c("forward", "backward"))
 

R/imap.R

@@ -10,9 +10,8 @@
 #'   * A named function, e.g. `paste`.
 #'   * An anonymous function, e.g. `\(x, idx) x + idx` or
 #'     `function(x, idx) x + idx`.
-#'   * A formula, e.g. `~ .x + .y`. You must use `.x` to refer to the
-#'     current element and `.y` to refer to the current index.
-#'     No longer recommended.
+#'   * A formula, e.g. `~ .x + .y`. Use `.x` to refer to the current element and
+#'     `.y` to refer to the current index. No longer recommended.
 #'
 #'   `r lifecycle::badge("experimental")`
 #'

R/keep.R

@@ -15,8 +15,9 @@
 #'
 #'   * A named function, e.g. `is.character`.
 #'   * An anonymous function, e.g. `\(x) all(x < 0)` or `function(x) all(x < 0)`.
-#'   * A formula, e.g. `~ all(.x < 0)`. You must use `.x` to refer to the first
-#'     argument). No longer recommended.
+#'   * A formula, e.g. `~ all(.x < 0)`. Use `.x` to refer to the first argument.
+#'     No longer recommended.
+#'
 #' @seealso [keep_at()]/[discard_at()] to keep/discard elements by name.
 #' @param ... Additional arguments passed on to `.p`.
 #' @export

R/map.R

@@ -23,7 +23,7 @@
 #'
 #'   * A named function, e.g. `mean`.
 #'   * An anonymous function, e.g. `\(x) x + 1` or `function(x) x + 1`.
-#'   * A formula, e.g. `~ .x + 1`. You must use `.x` to refer to the first
+#'   * A formula, e.g. `~ .x + 1`. Use `.x` to refer to the first
 #'     argument. No longer recommended.
 #'   * A string, integer, or list, e.g. `"idx"`, `1`, or `list("idx", 1)` which
 #'     are shorthand for `\(x) pluck(x, "idx")`, `\(x) pluck(x, 1)`, and

R/map2.R

@@ -10,7 +10,7 @@
 #'
 #'   * A named function.
 #'   * An anonymous function, e.g. `\(x, y) x + y` or `function(x, y) x + y`.
-#'   * A formula, e.g. `~ .x + .y`. You must use `.x` to refer to the current
+#'   * A formula, e.g. `~ .x + .y`. Use `.x` to refer to the current
 #'     element of `x` and `.y` to refer to the current element of `y`.
 #'     No longer recommended.
 #'

README.Rmd

@@ -75,3 +75,4 @@ There are two less obvious advantages:
 
 * All `map()` functions work with `in_parallel()` to easily spread computation 
   across multiple cores on your computer, or multiple machines over the network.
+