fixing man again

muschellij2 · May 13, 2024 · bc396d6 · bc396d6
1 parent 10f14f6
commit bc396d6
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 1.6.10
+Date: 2024-05-10 12:02:36 UTC
+SHA: 10f14f69f768256910de0e91fdb70ceb6a34d145
diff --git a/R/check_fs_result.R b/R/check_fs_result.R
@@ -6,7 +6,7 @@
 #' @param fe_before (logical) did the output file exist before the command ran
 #' @param fe_after (logical) did the output file exist after the command ran
 #'
-#' @return NULL
+#' @return No return value, called for side effects
 #' @export
 check_fs_result = function(res, fe_before, fe_after) {
   if (res != 0 & !fe_after) {

diff --git a/R/fs_setup.R b/R/fs_setup.R
@@ -321,7 +321,8 @@ fs_subj_dir  = function(){
 #' @description Sets the SUBJECTS_DIR variable in the system environment or 
 #' \code{options("fs.subj_dir" = x)} 
 #' @param x path to SUBJECTS_DIR defaults to \code{file.path(fs_dir(), "subjects")}
-#' @return NULL
+#' @return No return value, called for side effects (`SUBJECTS_DIR` 
+#' environment variable set, and `fs.subj_dir` option set)
 #' 
 #' @export
 set_fs_subj_dir  = function(x = file.path(fs_dir(), "subjects")){

diff --git a/man/check_fs_result.Rd b/man/check_fs_result.Rd
diff --git a/man/set_fs_subj_dir.Rd b/man/set_fs_subj_dir.Rd