summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess2015-10-16 15:19:29 -0400
committerJoey Hess2015-10-16 15:19:29 -0400
commit556cba2f6d0a85545d9a81baf66dbc848fff848e (patch)
tree9469fe269d680633f0a118372888f9e3b2cab494
parent40346113191977b6f49cdb4e9996c3a60ca40556 (diff)
clarify which param is which
-rw-r--r--src/Propellor/Property/File.hs8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/Propellor/Property/File.hs b/src/Propellor/Property/File.hs
index 12a3e80a..07ace24b 100644
--- a/src/Propellor/Property/File.hs
+++ b/src/Propellor/Property/File.hs
@@ -97,8 +97,12 @@ dirExists :: FilePath -> Property NoInfo
dirExists d = check (not <$> doesDirectoryExist d) $ property (d ++ " exists") $
makeChange $ createDirectoryIfMissing True d
--- | Creates or atomically updates a symbolic link. Does not overwrite regular
--- files or directories.
+-- | Creates or atomically updates a symbolic link.
+--
+-- The first parameter is what the link should point to.
+--
+-- The second parameter is the name of the symbolic link to create.
+-- Does not overwrite regular files or directories.
isSymlinkedTo :: FilePath -> FilePath -> Property NoInfo
link `isSymlinkedTo` target = property desc $
go =<< (liftIO $ tryIO $ getSymbolicLinkStatus link)