📝 Documentation gets a new git category

Move all git related functions into the new category. Revise the other categories.
inbo · Dec 10, 2024 · 3cc8199 · 3cc8199
1 parent 5711c24
commit 3cc8199
Show file tree

Hide file tree

Showing 50 changed files with 133 additions and 244 deletions.
diff --git a/R/clean_git.R b/R/clean_git.R
@@ -15,7 +15,7 @@
 #' git_remote_list
 #' @importFrom withr defer
 #' @export
-#' @family utils
+#' @family git
 clean_git <- function(repo =  ".", verbose = TRUE) {
   assert_that(is_workdir_clean(repo))
 

diff --git a/R/create_draft_pr.R b/R/create_draft_pr.R
@@ -8,7 +8,7 @@
 #' @importFrom gert git_info git_remote_info
 #' @importFrom gh gh
 #' @export
-#' @family package
+#' @family git
 create_draft_pr <- function(x = ".") {
   x <- read_checklist(x)
   stopifnot("Current version only relevant for R packages" = x$package)

diff --git a/R/new_branch.R b/R/new_branch.R
@@ -8,7 +8,7 @@
 #' @importFrom assertthat assert_that is.string
 #' @importFrom gert git_branch_list git_branch_create git_push
 #' @export
-#' @family utils
+#' @family git
 new_branch <- function(branch, verbose = TRUE, checkout = TRUE, repo =  ".") {
   assert_that(is.string(branch))
 

diff --git a/R/set_tag.R b/R/set_tag.R
@@ -15,7 +15,7 @@
 #' @importFrom gert git_config git_config_set git_info git_tag_create
 #' git_tag_list
 #' @importFrom withr defer
-#' @family package
+#' @family git
 set_tag <- function(x = ".") {
   if (
     !as.logical(Sys.getenv("GITHUB_ACTIONS", "false")) ||

diff --git a/R/update_citation.R b/R/update_citation.R
@@ -30,7 +30,7 @@
 #' @importFrom desc description
 #' @importFrom gert git_status
 #' @importFrom utils file_test
-#' @family package
+#' @family both
 update_citation <- function(x = ".", quiet = FALSE) {
   x <- read_checklist(x = x)
   cit_meta <- citation_meta$new(x$get_path)

diff --git a/R/utils.R b/R/utils.R
@@ -31,7 +31,7 @@ yesno <- function(...) {
 #' Otherwise `FALSE`
 #' @export
 #' @importFrom gert git_status
-#' @family utils
+#' @family git
 is_workdir_clean <- function(repo) {
   status <- git_status(repo = repo)
   status <- status[!(status$status == "new" & !status$staged), ]
@@ -255,7 +255,7 @@ quiet_cat <- function(x, quiet = FALSE, ...) {
 #' @importFrom gert git_find
 #' @return TRUE if directory is in a git repository else FALSE
 #' @export
-#' @family utils
+#' @family git
 is_repository <- function(path = ".") {
   out <- tryCatch(git_find(path = path), error = function(e) e)
   !any(class(out) == "error")

diff --git a/R/write_citation_cff.R b/R/write_citation_cff.R
@@ -9,7 +9,7 @@
 #' @param roles No longer used.
 #' @export
 #' @importFrom assertthat assert_that
-#' @family package
+#' @family both
 write_citation_cff <- function(x = ".", roles) {
   # nocov start
   .Deprecated(new = "update_citation", package = "checklist")

diff --git a/R/write_zenodo_json.R b/R/write_zenodo_json.R
@@ -12,7 +12,7 @@
 #' @importFrom desc description
 #' @importFrom jsonlite toJSON
 #' @importFrom gert git_status
-#' @family package
+#' @family both
 write_zenodo_json <- function(x = ".") {
   .Deprecated(new = "update_citation", package = "checklist") # nocov start
   x <- update_citation(x = x)

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -60,6 +60,9 @@ reference:
 - title: Setting up a project use the checklist package
   contents:
   - has_concept("setup")
+- title: Git related functions
+  contents:
+  - has_concept("git")
 - title: R6 class behind the checklist package
   contents:
   - has_concept("class")

diff --git a/man/add_badges.Rd b/man/add_badges.Rd
diff --git a/man/ask_yes_no.Rd b/man/ask_yes_no.Rd
diff --git a/man/author2df.Rd b/man/author2df.Rd
diff --git a/man/bookdown_zenodo.Rd b/man/bookdown_zenodo.Rd
diff --git a/man/c_sort.Rd b/man/c_sort.Rd
diff --git a/man/check_codemeta.Rd b/man/check_codemeta.Rd
diff --git a/man/check_cran.Rd b/man/check_cran.Rd
diff --git a/man/check_description.Rd b/man/check_description.Rd
diff --git a/man/check_documentation.Rd b/man/check_documentation.Rd
diff --git a/man/check_environment.Rd b/man/check_environment.Rd
diff --git a/man/check_filename.Rd b/man/check_filename.Rd
diff --git a/man/check_license.Rd b/man/check_license.Rd
diff --git a/man/check_lintr.Rd b/man/check_lintr.Rd
diff --git a/man/check_package.Rd b/man/check_package.Rd
diff --git a/man/check_spelling.Rd b/man/check_spelling.Rd
diff --git a/man/clean_git.Rd b/man/clean_git.Rd
diff --git a/man/create_draft_pr.Rd b/man/create_draft_pr.Rd
diff --git a/man/create_hexsticker.Rd b/man/create_hexsticker.Rd
diff --git a/man/custom_dictionary.Rd b/man/custom_dictionary.Rd
diff --git a/man/default_organisation.Rd b/man/default_organisation.Rd
diff --git a/man/defunct.Rd b/man/defunct.Rd