update doc

epicentre-msf · Oct 5, 2023 · ca186a1 · ca186a1
1 parent b1a4871
commit ca186a1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/R/install_rpxl.R b/R/install_rpxl.R
@@ -2,12 +2,11 @@
 #'
 #' @param envname Name of Python environment to install within. Defaults to
 #' "r-rpxl".
-#' @param new_env Logical indicating whether to remove the existing virtual
-#' environment of the same name as `envname` before installing the required
-#' Python packages.
+#' @param new_env Logical indicating whether to remove an existing virtual
+#' environment, if it has the name as `envname`, before creating the new
+#' virtual environment and installing the required Python packages.
 #' @param method Installation method. Defaults to "auto" to automatically find a
-#' method that will work in the local environment. Note that the "virtualenv"
-#' method is not available on Windows.
+#' method that will work in the local environment.
 #' @param ... Additional arguments passed to [reticulate::py_install]
 #'
 #' @importFrom reticulate py_install virtualenv_exists virtualenv_remove

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