update man entries for ropensci-org#76

mpadge · Jul 23, 2024 · 4a36598 · 4a36598
1 parent 903c7ea
commit 4a36598
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/R/pkg-versions.R b/R/pkg-versions.R
@@ -1,3 +1,6 @@
+# Functions to extract version numbers of packages, both from CRAN and latest
+# GitHub releases.
+
 check_pkg_version_path <- function () {
     cm_path <- normalizePath (file.path ("raw_cm.json"), mustWork = FALSE)
 
@@ -13,7 +16,13 @@ check_pkg_version_path <- function () {
     return (cm_path)
 }
 
-#' Ensure CRAN versions are released on GitHUb
+#' Extract data on releases of packages, both on CRAN and GitHub.
+#'
+#' @param CRAN_only If `TRUE`, return only those rows of `repo_data` which
+#' correspond to packages which are or were on CRAN; otherwise return all data.
+#' @return A `data.frame` with one row for each package, and columns containing
+#' information on the package including dates and version numbers of GitHub and
+#' CRAN releases (if any).
 #'
 #' @export
 registry_pkg_versions <- function (CRAN_only = TRUE) {

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