HELP: Be more explicit that argument 'logical' for availableCores() i…

…s ignored on Linux [#92] [ci skip]
futureverse · Dec 10, 2022 · 27a54b5 · 27a54b5
1 parent c30d30a
commit 27a54b5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/R/availableCores.R b/R/availableCores.R
@@ -15,8 +15,10 @@
 #' @param na.rm If TRUE, only non-missing settings are considered/returned.
 #'
 #' @param logical Passed to
-#' \code{\link[parallel]{detectCores}(logical = logical)}, which, if supported,
-#' returns the number of logical CPUs (TRUE) or physical CPUs/cores (FALSE).
+#' \code{\link[parallel]{detectCores}(logical = logical)}, which,
+#' _if supported_, returns the number of logical CPUs (TRUE) or physical
+#' CPUs/cores (FALSE).
+#' At least as of R 4.2.2, `detectCores()` this argument on Linux.
 #' This argument is only if argument `methods` includes `"system"`.
 #'
 #' @param default The default number of cores to return if no non-missing

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