From 1aeb92d657e740b3762a7c3128f812e761c944bf Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@hasufell.de>
Date: Wed, 23 Dec 2015 16:10:08 +0100
Subject: [PATCH] LIB: fix documentation in IO.File

---
 src/IO/File.hs | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/IO/File.hs b/src/IO/File.hs
index 7006ac1..5f372a7 100644
--- a/src/IO/File.hs
+++ b/src/IO/File.hs
@@ -127,7 +127,7 @@ runFileOp _                       = return Nothing
 
 -- TODO: allow renaming
 -- |Copies a directory to the given destination with the specified
--- `DirCopyMode`.
+-- `DirCopyMode`. Excludes symlinks.
 copyDir :: DirCopyMode
         -> AnchoredFile FileInfo FileInfo  -- ^ source dir
         -> AnchoredFile FileInfo FileInfo  -- ^ destination dir
@@ -191,7 +191,8 @@ recreateSymlink symf@(IsSymL True)
 recreateSymlink _ _ = return ()
 
 
--- |Copies the given file to the given file destination. Not symlinks.
+-- |Copies the given file to the given file destination.
+-- Excludes symlinks.
 copyFile :: AnchoredFile FileInfo FileInfo  -- ^ source file
          -> AnchoredFile FileInfo FileInfo  -- ^ destination file
          -> IO ()
@@ -205,7 +206,7 @@ copyFile _ _ = return ()
 
 
 -- |Copies the given file to the given dir with the same filename.
--- This can also be called on symlinks.
+-- Excludes symlinks.
 copyFileToDir :: AnchoredFile FileInfo FileInfo
               -> AnchoredFile FileInfo FileInfo
               -> IO ()
@@ -219,6 +220,8 @@ copyFileToDir from@(_ :/ RegFile fn _)
 copyFileToDir _ _ = return ()
 
 
+-- |Copies a file, directory or symlink. In case of a symlink, it is just
+-- recreated, even if it points to a directory.
 easyCopy :: DirCopyMode
          -> AnchoredFile FileInfo FileInfo
          -> AnchoredFile FileInfo FileInfo
@@ -322,7 +325,8 @@ deleteDirRecursive _ = return ()
 
 
 -- |Deletes a file, directory or symlink, whatever it may be.
--- In case of directory, performs recursive deletion.
+-- In case of directory, performs recursive deletion. In case of
+-- a symlink, the symlink file is deleted.
 easyDelete :: AnchoredFile FileInfo FileInfo -> IO ()
 easyDelete f@(IsSymL True) = deleteSymlink f
 easyDelete f@(_ :/ RegFile {})