more CRAN fixes

Author: lorenzwalthert

R/config.R

@@ -23,6 +23,10 @@
 #' @inheritParams fallback_doc
 #' @return
 #' Character vector of length one with the path to the config file used.
+#' @examples
+#' \dontrun{
+#' use_precommit_config()
+#' }
 #' @export
 use_precommit_config <- function(config_source = getOption("precommit.config_source"),
                                  force = FALSE,

R/exec.R

@@ -7,6 +7,10 @@
 #'  exists.
 #' @return
 #'  A character vector of length one with the path to the pre-commit executable.
+#' @examples
+#' \dontrun{
+#' path_precommit_exec()
+#' }
 #' @export
 path_precommit_exec <- function(check_if_exists = TRUE) {
   final <- getOption("precommit.executable") %>%
@@ -27,6 +31,10 @@ path_precommit_exec <- function(check_if_exists = TRUE) {
 }
 
 #' @rdname path_precommit_exec
+#' @examples
+#' \dontrun{
+#' path_pre_commit_exec()
+#' }
 #' @export
 path_pre_commit_exec <- function(check_if_exists = TRUE) {
   .Deprecated("path_precommit_exec", old = "path_pre_commit_exec")

R/install.R

@@ -35,6 +35,10 @@ install_system <- function(force) {
 #' @param force Whether or not to force a re-installation.
 #' @return
 #' The path to the pre-commit executable (invisibly).
+#' @examples
+#' \dontrun{
+#' install_precommit()
+#' }
 #' @export
 install_precommit <- function(force = FALSE) {
   install_system(force = force)
@@ -50,22 +54,21 @@ install_impl <- function() {
 }
 
 install_repo <- function(root, install_hooks, legacy_hooks) {
-  
   withr::with_dir(root, {
     remove_usethis_readme_hook()
     out <- call_precommit(
-      "install", 
-      if (install_hooks) "--install-hooks", 
-      if (legacy_hooks == 'remove') "--overwrite"
+      "install",
+      if (install_hooks) "--install-hooks",
+      if (legacy_hooks == "remove") "--overwrite"
     )
     if (out$exit_status == 0) {
       if (any(grepl("Use -f to use only pre-commit.", out$stdout, fixed = TRUE))) {
-        if (legacy_hooks == 'forbid') {
+        if (legacy_hooks == "forbid") {
           rlang::abort(paste(
             "There are existing hooks installed for this repo and the argument",
-            "`legacy_hooks` is set to `'forbid'`. We recommend inspecting these" , 
+            "`legacy_hooks` is set to `'forbid'`. We recommend inspecting these",
             "and removing them manually or - if you are sure you don't need",
-            "them anymore - call this function again with", 
+            "them anymore - call this function again with",
             "`legacy_hooks = 'remove'` to remove them for you.",
             "If you want to continue to use these hooks, set",
             "`legacy_hooks` to `'allow'`, which means pre-commit will run in ",
@@ -91,18 +94,18 @@ install_repo <- function(root, install_hooks, legacy_hooks) {
 
 remove_usethis_readme_hook <- function() {
   legacy <- readLines(
-    system.file("usethis-legacy-hook", package = 'precommit'), 
+    system.file("usethis-legacy-hook", package = "precommit"),
     encoding = "UTF-8"
   )
   candidate <- ".git/hooks/pre-commit"
   if (fs::file_exists(candidate)) {
     if (identical(readLines(candidate, encoding = "UTF-8"), legacy)) {
       fs::file_delete(candidate)
       usethis::ui_info(paste(
-        "Removed the render-README hook, which was added with", 
+        "Removed the render-README hook, which was added with",
         "`usethis::use_readme_rmd()` to this repo at some point in the past.",
-        "{{precommit}}'s equivalent is the hook with the id 'readme-rmd-rendered'.", 
-        "Add the hook to your .pre-commit-config.yaml as described here:", 
+        "{{precommit}}'s equivalent is the hook with the id 'readme-rmd-rendered'.",
+        "Add the hook to your .pre-commit-config.yaml as described here:",
         "https://lorenzwalthert.github.io/precommit/#usage."
       ))
     }
@@ -123,6 +126,10 @@ remove_usethis_readme_hook <- function() {
 #' @inheritParams fallback_doc
 #' @return
 #' `NULL` (invisibly). The function is called for its side effects.
+#' @examples
+#' \dontrun{
+#' uninstall_precommit()
+#' }
 #' @export
 uninstall_precommit <- function(scope = "repo",
                                 ask = "user",

R/open.R

@@ -8,6 +8,10 @@
 #' @return
 #' `NULL` (invisibly). The function is called for its side effects.
 #' @family helpers
+#' @examples
+#' \dontrun{
+#' open_config()
+#' }
 #' @export
 open_config <- function(root = here::here()) {
   if (rstudioapi::isAvailable()) {
@@ -18,8 +22,12 @@ open_config <- function(root = here::here()) {
   invisible(NULL)
 }
 
-#' @export
 #' @rdname open_config
+#' @examples
+#' \dontrun{
+#' open_wordlist()
+#' }
+#' @export
 open_wordlist <- function(root = here::here()) {
   rstudioapi::navigateToFile(fs::path(root, "inst", "WORDLIST"))
   invisible(NULL)

R/roxygen2.R

@@ -50,6 +50,10 @@ extract_diff_root <- function(root = here::here()) {
 #' @return
 #' A logical vector of length 1.
 #' @inheritParams extract_diff_root
+#' @examples
+#' \dontrun{
+#' diff_requires_run_roxygenize()
+#' }
 #' @export
 diff_requires_run_roxygenize <- function(root = here::here()) {
   if (!rlang::is_installed("git2r")) {

R/setup.R

@@ -3,9 +3,9 @@
 #' Get started.
 #' @param install_hooks Whether to install environments for all available hooks.
 #'   If `FALSE`, environments are installed with first commit.
-#' @param legacy_hooks How to treat hooks already in the repo which are not 
+#' @param legacy_hooks How to treat hooks already in the repo which are not
 #'   managed by pre-commit. "forbid", the default, will cause  `use_precommit()`
-#'   to fail if there are such hooks. "allow" will run these along with 
+#'   to fail if there are such hooks. "allow" will run these along with
 #'   pre-commit. "remove" will delete them.
 #' @inheritParams fallback_doc
 #' @inheritParams use_precommit_config
@@ -29,10 +29,14 @@
 #' @family helpers
 #' @return
 #' `NULL` (invisibly). The function is called for its side effects.
+#' @examples
+#' \dontrun{
+#' use_precommit()
+#' }
 #' @export
 use_precommit <- function(config_source = getOption("precommit.config_source"),
                           force = FALSE,
-                          legacy_hooks = 'forbid',
+                          legacy_hooks = "forbid",
                           open = rstudioapi::isAvailable(),
                           install_hooks = TRUE,
                           root = here::here()) {
@@ -58,6 +62,10 @@ use_precommit <- function(config_source = getOption("precommit.config_source"),
 #' @return
 #' The exit status from `pre-commit autoupdate` (invisibly).
 #' @inheritParams fallback_doc
+#' @examples
+#' \dontrun{
+#' autoupdate()
+#' }
 #' @export
 autoupdate <- function(root = here::here()) {
   withr::with_dir(root, {

cran-comments.md

@@ -13,3 +13,18 @@
 ## Downstream Dependencies
 
 None.
+
+## Resubmission 
+
+This is the first re-submission. I have: 
+
+- removed the redundant 'for R' from the `Title:` in DESCRIPTION.
+- extended `Description:` to be a longer description of what the package does in 
+  `DESCRIPTION`.
+- added return value documentation for exported function in the case there was 
+  none before.
+- added examples to the exported functions.
+
+I was also asked to add references for the methods I implement but there are 
+none as this is a tooling package that does not implement any statistical 
+method.

inst/WORDLIST

@@ -24,6 +24,7 @@ dirname
 docopt
 docsearch
 docType
+dontrun
 emph
 env
 EOF
@@ -84,6 +85,7 @@ readme
 Renviron
 repo
 repos
+Resubmission
 reticulate
 Rhistory
 rlang