Fixing documentation

DESCRIPTION

@@ -54,8 +54,9 @@ Suggests:
     rmarkdown,
     testthat,
     UNF
+Remotes: leeper/UNF
 VignetteBuilder: 
     knitr
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.0.2
+RoxygenNote: 7.2.1

R/name_chunks.R

@@ -6,6 +6,8 @@
 #'  before pushing them to your code base. Such automatic
 #'  chunk labelling is best paired with version control.
 #'
+#' @returns Always returns TRUE invisibly. Called for side effects.
+#'
 #' @template path
 #' @template unname
 #'
@@ -30,7 +32,7 @@ name_chunks <- function(path, unname = FALSE){
 
   # early exit if no chunk
   if(is.null(chunk_headers_info)){
-    return(invisible("TRUE"))
+    return(invisible(TRUE))
   }
 
   # check if a force-unname should be done
@@ -91,13 +93,15 @@ Maybe namer::unname_chunks before running name_chunks.")
     # save file
     writeLines(lines, path)
 }
-  return(invisible("TRUE"))
+  return(invisible(TRUE))
 }
 
 #' @title  Name chunks of all Rmds in a dir
 #'
 #' @description  Name unnamed chunks in a dir using the filenames with extension stripped as basis.
 #'
+#' @returns Always returns TRUE invisibly. Called for side effects.
+#'
 #' @inherit name_chunks details
 #'
 #' @template dir
@@ -132,6 +136,8 @@ name_dir_chunks <- function(dir, unname = FALSE){
 
   rmds <- fs::dir_ls(dir, regexp = "*.[Rr]md")
   purrr::walk(rmds, chatty_name_chunks)
+
+  return(invisible(TRUE))
 }
 
 chatty_name_chunks <- function(path){

R/unname_chunks.R

@@ -4,6 +4,8 @@
 #' or alternatively only unname the chunknames with a given prefix.
 #' In both cases, the chunk name "setup" is preserved, that chunk is never unnamed.
 #'
+#' @returns Always returns TRUE invisibly. Called for side effects.
+#'
 #' @inherit name_chunks details
 #'
 #' @template path
@@ -60,12 +62,16 @@ unname_chunks <- function(path, chunk_name_prefix = NULL) {
 
   # save file
   writeLines(lines, path)
+
+  return(invisible(TRUE))
 }
 
 #' @title  Unname chunks of all Rmds in a dir
 #'
 #' @description  Name unnamed chunks in a dir using the filenames with extension stripped as basis.
 #'
+#' @returns Always returns TRUE invisibly. Called for side effects.
+#'
 #' @inherit name_chunks details
 #'
 #' @template dir
@@ -91,6 +97,7 @@ unname_chunks <- function(path, chunk_name_prefix = NULL) {
 unname_dir_chunks <- function(dir){
   rmds <- fs::dir_ls(dir, regexp = "*.[Rr]md")
   purrr::walk(rmds, chatty_unname_chunks)
+  return(invisible(TRUE))
 }
 
 chatty_unname_chunks <- function(path){

R/utils-pipe.R

@@ -1,11 +1,14 @@
 #' Pipe operator
 #'
-#' See `magrittr::[\%>\%][magrittr::\%>\%]` for details.
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
 #'
 #' @name %>%
 #' @rdname pipe
 #' @keywords internal
 #' @export
 #' @importFrom magrittr %>%
 #' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
 NULL