document getLinkFunction

pik-piam · May 3, 2024 · f2e3b2e · f2e3b2e
1 parent 22ebf79
commit f2e3b2e
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/R/getLinkFunction.R b/R/getLinkFunction.R
@@ -1,15 +1,14 @@
 #' getLinkFunction
 #'
-#' Returns a function that symlinks, hardlinks, or copies files and
-#' directories, depending on OS capabilities.
+#' Returns a function that creates a symlink, hardlink, junction, or copy of
+#' files and directories, depending on OS capabilities (usually symlinks are
+#' not supported on Windows).
 #'
 #' @return A function with arguments "from" and "to" which should behave like
 #' file.symlink on all platforms.
 #' @author Pascal Sauer
 #' @export
 getLinkFunction <- function() {
-  # try symlinks, if they don't work (Windows) fall back to hardlinks/junctions/copying
-
   withr::local_dir(withr::local_tempdir())
 
   writeLines("a", "a")