Errors in fct_reorder2 documentation

[AlexJHomer]

forcats/R/reorder.R

Lines 9 to 11 in 4a8525a

	#' @param .x,.y The levels of `f` are reordered so that the values
	#' of `.fun(.x)` (for `fct_reorder()`) and `fun(.x, .y)` (for `fct_reorder2()`)
	#' are in ascending order.

The phrase "ascending order" is misleading, since for fct_reorder2 the default is to use descending order instead, and in any case the direction is controlled by the .desc argument.

f <- factor(c("a", "a", "b"))
f
#> [1] a a b
#> Levels: a b

x <- c(1, 2, 3)
y <- c(2, 4, 6)
fun <- \(x, y) mean(x + y)

# fun gives a lower value for "a" than for "b":
fun(x[f == "a"], y[f == "a"])
#> [1] 4.5
fun(x[f == "b"], y[f == "b"])
#> [1] 9

forcats::fct_reorder2(f, x, y, fun)
#> [1] a a b
#> Levels: b a

^{Created on 2023-06-24 with reprex v2.0.2}

Less crucially, it should read `.fun(.x, .y)` instead of `fun(.x, .y)`.