Merge pull request #1 from A2-ai/rcmdcheck

fixes yaml for rcmdcheck gha

.github/workflows/R-CMD-check.yaml

@@ -13,8 +13,7 @@ permissions: read-all
 jobs:
   R-CMD-check:
     runs-on: ${{ matrix.config.os }}
-    env:
-      GHQC_INFO_REPO: "https://github.com/A2-ai/ghqc.a2ai.git"
+
     name: ${{ matrix.config.os }} (${{ matrix.config.r }})
 
     strategy:

R/download_packages.R

@@ -12,12 +12,6 @@
 #' @importFrom withr with_options
 #'
 #' @export
-#'
-#'
-#' @examples
-#' \dontrun{
-#' install_ghqcapp_dependencies()
-#' }
 install_ghqcapp_dependencies <- function(lib_path = ghqc_libpath(),
                                       pkgs = ghqc_depends,
                                       use_pak = TRUE) {

R/utils.R

@@ -1,12 +1,11 @@
-#' The default install location for the ghqc package and its dependency. If it does not exist, it will be created
+#' The default install location for the ghqc package and its dependencies. If it does not exist, it will be created.
 #'
-#' @return string containing the default lib path for the ghqc package and its dependencies
+#' @return string containing the default lib path for the ghqc package and its dependencies (~/.local/share/ghqc/rpkgs)
 #'
 #' @importFrom fs dir_exists
 #' @importFrom fs dir_create
 #'
 #' @export
-#' @examples ghqc_libpath()
 ghqc_libpath <- function() {
   lib_path <- "~/.local/share/ghqc/rpkgs"
   if (!fs::dir_exists(lib_path)) fs::dir_create(lib_path, recurse = TRUE)
@@ -15,9 +14,8 @@ ghqc_libpath <- function() {
 
 #' The default install location for the ghqc customizing information repository
 #'
-#' @return string containing the default path to the ghqc information repository
+#' @return string containing the default path to the ghqc information repository (~/.local/share/ghqc/&lt;info repo name here&gt;
 #' @export
-#' @examples ghqc_infopath()
 ghqc_infopath <- function() {
   file.path("~/.local/share/ghqc", info_repo_name())
 }