Merge pull request #157 from ropensci-review-tools/docs

update docs for pkg embeddings

Author: mpadge

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: pkgmatch
 Title:  Find R Packages Matching Either Descriptions or Other R Packages
-Version: 0.4.3.154
+Version: 0.4.3.155
 Authors@R: c(
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265")),

R/embeddings.R

@@ -34,6 +34,12 @@ convert_paths_to_pkgs <- function (packages) {
 #' (\url{https://ollama.com/jina/jina-embeddings-v2-base-en} for text, and
 #' \url{https://ollama.com/ordis/jina-embeddings-v2-base-code} for code).
 #'
+#' @note Although it is technically much faster to perform the extraction of
+#' text and code in parallel, doing so generates unpredictable errors in
+#' extracting tarballs, which frequently cause the whole process to crash. The
+#' only way to safely ensure that all tarballs are successfully extracted and
+#' code parsed it to run this single-threaded.
+#'
 #' @param packages A vector of either names of installed packages, or local
 #' paths to directories containing R packages.
 #' @param n_chunks Number of randomly permuted chunks of input text to use to

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/pkgmatch",
   "issueTracker": "https://github.com/ropensci-review-tools/pkgmatch/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.4.3.154",
+  "version": "0.4.3.155",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",